---
title: "List persons"
method: GET
path: "/v1/locations/{locationId}/persons"
tags: ["Persons"]
---

# List persons

`GET /v1/locations/{locationId}/persons`

## Request

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

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.

## Path parameters

- `locationId` string, required

## Query parameters

- `email` string
- `phoneNumber` string
- `identityNumber` string
- `externalReference` string
- `limit` integer
- `after` string

## Response `200`

OK

- PersonList
  - `data` Person[], required
    - `address` Address
      - `city` string, nullable
      - `country` string, nullable: Free text; an ISO 3166-1 alpha-2 code is recommended.
      - `line1` string, nullable
      - `line2` string, nullable
      - `line3` string, nullable
      - `postCode` string, nullable
    - `communication` Communication, required: What the person has agreed to receive. In an update, a field you leave out keeps its value. For a new person `smsReminders`, `emailReminders` and `reviewReminders` start as true and `marketing` as false: send `marketing` as true only when the person has agreed to marketing.
      - `emailReminders` boolean: Booking reminders by email.
      - `marketing` boolean: Marketing messages.
      - `reviewReminders` boolean: Requests to review a visit.
      - `smsReminders` boolean: Booking reminders by SMS.
    - `createdAt` string, date-time
    - `dateOfBirth` string: ISO 8601 date.
    - `email` string
    - `externalReference` string: Your own id for it, as sent when it was created.
    - `gender` string: One lower-case word such as `female`. More values may be added.
    - `id` string, required
    - `identityNumber` IdentityNumber: A number issued by an authority that identifies a person, such as a personnummer. The accepted format of each type is listed under Persons.
      - `number` string, required: In the format of its type: twelve digits for a Swedish personnummer.
      - `type` string, required: The kind of number, in lower case, such as `se_personnummer` or `foreign`. More values may be added.
    - `locationId` string, required
    - `name` string
    - `notes` string: Staff-facing notes, at most 1000 characters.
    - `onlineBookingBlocked` boolean, required: True when the person may not book online.
    - `otherPhoneNumber` string
    - `owner` CustomerOwner, required: Whose customer a person is within its location: the location's own, or that of one of the location's resources. A salon that rents out chairs uses it: a person served by a hairdresser who rents a chair is that resource's customer, and a person served by an employee is the location's. Many locations never record it, so `unassigned` is common and says nothing either way.
      - `resourceId` string: The resource (see Resources) whose customer the person is. Present when `type` is `resource`.
      - `type` 'location' | 'resource' | 'unassigned', required: `location`: the location's own customer. `resource`: the customer of one resource, named by `resourceId`. `unassigned`: not recorded. More values may be added.
    - `phoneNumber` string: Mobile number, in E.164 format when it was set through this API.
    - `updatedAt` string, date-time
  - `nextCursor` string: Pass as `after` to fetch the next page. Absent on the last page.

## Other responses

- `default`: Any failure. See the Errors section.

---

[API](https://skmtc.dev/cliento/apis/cliento-api.md) · [All operations](https://skmtc.dev/cliento/apis/cliento-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cliento/apis/cliento-api/revisions/29ca811bc061?raw)