Customers

List customers of every type

The location's persons, companies and vehicles in one list of short entries, oldest first. Use it to find something when you do not know its type, for example from a phone number; then read it in full from Persons, Companies or Vehicles, as the id's prefix and type say.

get/v1/locations/{locationId}/customers

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/customers
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Query parameters

typestring[]

Only these kinds: person, company or vehicle. Repeat the parameter for several.

emailstring

Only those with exactly this email address. Letter case is ignored.

phoneNumberstring

Only those with exactly this mobile number, in E.164 format. Percent-encode the plus sign as %2B.

numberstring

Only those with exactly this number: an identity number, an organisation number or a registration number.

externalReferencestring

Only the one you created with this externalReference.

limitinteger

Page size, 1 to 200. Default 50.

afterstring

The nextCursor of the previous page.

Response

OK

nextCursorstring

Pass as after to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "id": "per_2QCtWVSaVO7yCRYBj1zsbA",
      "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
      "name": "Anna Lindqvist",
      "number": "198604122385",
      "type": "person"
    }
  ],
  "nextCursor": "per_2QCtWVSaVO7yCRYBj1zsbA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.