Skip to content
Komplett LogoKomplett Platform

Search customers

GET
/v1
curl --request GET \
  --url https://example.com/customers/v1

Searches customers by email and/or mobile, scoped to the caller’s own store. At least one of email or mobile is required. Supports optional paging via pageSize/continuationToken. Results are filtered by the caller’s per-customer access, which is applied after paging: a page may therefore contain fewer than pageSize customers, or be empty while still returning a continuationToken. Keep following the continuationToken until it is null to retrieve all results.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
email
string
mobile
string
customerType
string
pageSize
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
continuationToken
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
customers
required
Array<object>
object
customerId
required
string
name
required
string
email
null | string
mobile
null | string
customerType
required
string
isB2B
boolean
isPublic
boolean
country
required
string
primaryAddress
One of:
null
organizationNumber
null | string
organizationData
One of:
null
continuationToken
null | string
Examplegenerated
{
  "customers": [
    {
      "customerId": "example",
      "name": "example",
      "email": "example",
      "mobile": "example",
      "customerType": "example",
      "isB2B": true,
      "isPublic": true,
      "country": "example",
      "primaryAddress": {
        "streetLine1": "example",
        "streetLine2": "example",
        "postalCode": "example",
        "city": "example",
        "country": "example"
      },
      "organizationNumber": "example",
      "organizationData": {
        "subOrganizationName": "example",
        "subOrganizationNumber": "example",
        "organizationCountry": "example",
        "organizationIds": "example"
      }
    }
  ],
  "continuationToken": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}