List persons

The location's persons, oldest first, one page at a time. To find one, use the filters instead of reading the whole list; "Finding a person" under Persons says how each one matches.

get/v1/locations/{locationId}/persons

Request

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

Path parameters

locationIdstring required

Query parameters

emailstring

Only persons with exactly this email address, whatever its letter case.

phoneNumberstring

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

identityNumberstring

Only persons with exactly this identity number, as it is stored: a Swedish personnummer is twelve digits.

externalReferencestring

Only the person you created with this externalReference.

limitinteger

Page size, 1 to 200. Default 50.

afterstring

The nextCursor of the previous page.

Response

nextCursorstring

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

Example response

{
  "data": [
    {
      "address": {
        "city": "Stockholm",
        "country": "SE",
        "line1": "Storgatan 12",
        "line2": "Lgh 1102",
        "postCode": "111 51"
      },
      "dateOfBirth": "1986-04-12",
      "email": "anna.lindqvist@example.com",
      "externalReference": "crm-88121",
      "gender": "female",
      "id": "per_2QCtWVSaVO7yCRYBj1zsbA",
      "identityNumber": {
        "number": "198604122385",
        "type": "se_personnummer"
      },
      "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
      "name": "Anna Lindqvist",
      "otherPhoneNumber": "+4686543210",
      "owner": {
        "resourceId": "res_2QCtWVSaVO7yCRYBj1zsbA"
      },
      "phoneNumber": "+46701234567"
    }
  ],
  "nextCursor": "per_2QCtWVSaVO7yCRYBj1zsbA"
}

Changes

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