Skip to main content
GET
/
persons
List persons
curl --request GET \
  --url https://api.montereyfinancial.app/persons \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "is_active": true
    }
  ],
  "page": {
    "has_more": true,
    "limit": 123,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Static API key issued via the client portal. Treat it like a password.

Query Parameters

​
cursor
string | null

Opaque pagination cursor from a previous response's page.next_cursor. Omit on the first page.

​
limit
integer | null

Page size for cursor pagination. Default 100, minimum 1, maximum 1000. Requests above the maximum return 422 — narrow your page size and use the returned next_cursor to walk additional pages.

Required range: 1 <= x <= 1000

Response

Successful Response

A page of results: items plus a page pagination envelope.

​
items
PersonRow · object[]
required
​
page
PageMeta · object
required

Pagination envelope on list responses. next_cursor is non-null when more rows exist — pass it back as cursor to continue.