Skip to main content
GET
/
record-types
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "fields": [
        {
          "name": "<string>",
          "label": "<string>",
          "piiClass": "<string>",
          "source": "<string>"
        }
      ],
      "source": "<string>",
      "recordCount": 123,
      "lastRecordReceivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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

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

Response

200 - application/json

Paginated object types.

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