Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "rec_7f2a01",
"objectType": "contacts",
"source": "api",
"externalId": "crm_88213",
"fields": {
"name": "Dana Ruiz",
"phone": "+14155550142",
"email": "dana@example.com",
"plan": "Gold"
},
"fieldUpdatedAt": {
"name": "2026-07-12T10:00:00.000Z"
},
"phoneE164": "+14155550142",
"email": "dana@example.com",
"tombstonedAt": null,
"createdAt": "2026-07-12T10:00:00.000Z",
"updatedAt": "2026-07-12T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Records
List caller-context records
Paged list of live records of an object type, with an optional case-insensitive q filter over external ID, phone, email, or the record’s fields. Deleted (tombstoned) records are excluded.
GET
/
records
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "rec_7f2a01",
"objectType": "contacts",
"source": "api",
"externalId": "crm_88213",
"fields": {
"name": "Dana Ruiz",
"phone": "+14155550142",
"email": "dana@example.com",
"plan": "Gold"
},
"fieldUpdatedAt": {
"name": "2026-07-12T10:00:00.000Z"
},
"phoneE164": "+14155550142",
"email": "dana@example.com",
"tombstonedAt": null,
"createdAt": "2026-07-12T10:00:00.000Z",
"updatedAt": "2026-07-12T10:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
records:read
Read the pre-synced Caller Context Store records and object-type field registry.
Query Parameters
The object type to list (e.g. "contacts").
Case-insensitive filter over externalId / phone / email / fields.
1-based page number for offset pagination. Defaults to 1 (the first page).
Required range:
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
Required range:
1 <= x <= 100