Customers

List customers across locations

Lists the persons, companies and vehicles of every location this API key can be used on, as short entries, one page at a time. The call works only when sharing customers between locations is turned on for the organisation in Cliento. Otherwise it is refused with not_allowed, and you list customers per location instead. Each entry has the locationId it is registered at. Read the full record, change it or delete it under that location, in Persons, Companies or Vehicles. The filters work as on a location's list.

get/v1/customers

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/customers
  • Auth: HTTP bearer

Query parameters

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.

externalReferencestring

Only those you created with this externalReference. A reference is unique within a location, not across them, so the list can return one match per location.

numberstring

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

typestring[]

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

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.