Skip to main content
GET
/
records
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "source": "<string>",
      "externalId": "<string>",
      "fields": {},
      "fieldUpdatedAt": {},
      "tombstonedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "phoneE164": "<string>",
      "email": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "nextCursor": "<string>"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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.

Query Parameters

objectType
string
required

The object type to list (e.g. "contacts").

q
string

Case-insensitive filter over externalId / phone / email / fields.

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Paginated records.

success
boolean
required
data
object[]
required
pagination
object
required
message
string
errors
object[]