Skip to main content
GET
/
people
List people
curl --request GET \
  --url https://api.clearpolicy.app/api/v1/people \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "phone": "<string>",
      "source_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.clearpolicy.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth 2.0 bearer token obtained via the client credentials flow with the api:use scope.

Query Parameters

id
string

Filter by exact ULID. When provided, returns a non-paginated array containing only that person (or an empty array).

name
string

Filter by name (case-insensitive partial match).

Maximum string length: 255
email
string

Filter by email (case-insensitive partial match).

Maximum string length: 255
phone
string

Filter by phone number (partial match).

Maximum string length: 50
archived
enum<string>
default:false

When true or 1, returns only archived people. When omitted or false, returns only active people.

Available options:
true,
false,
1,
0
per_page
integer
default:25

Number of results per page (1–100).

Required range: 1 <= x <= 100
page
integer
default:1

Page number to retrieve.

Required range: x >= 1

Response

A paginated list of people.

data
object[]
meta
object
Last modified on May 27, 2026