Skip to main content
GET
/
v1
/
client
고객 목록
curl --request GET \
  --url https://openapi.pluuug.com/v1/client \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Signature: <api-key>'
{
  "results": [
    {
      "id": 123,
      "companyName": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "status": {
        "id": 123,
        "title": "<string>"
      },
      "inCharge": "<string>",
      "position": "<string>",
      "contact": "<string>",
      "email": "jsmith@example.com"
    }
  ],
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}

Authorizations

​
X-API-Key
string
header
required
​
X-Signature
string
header
required

HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다. 서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.

Query Parameters

​
created_end
string<date>

생성일 종료 (YYYY-MM-DD)

​
created_start
string<date>

생성일 시작 (YYYY-MM-DD)

​
cursor
string

Pagination을 위한 커서

​
is_hidden
boolean

숨김 처리 여부 필터 (true: 숨김 항목만, false: 비숨김 항목만, 미전달: 전체)

​
page_size
integer

한번에 조회할 데이터의 개수 (limit)

​
search
string[]

검색어 (복수 전달 시 AND 결합). 회사명/담당자/연락처/이메일에 대해 부분 일치(icontains).

​
status_id
string

Response

200 - application/json
​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"