Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"name": "name",
"label": "Name",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "phone",
"label": "Phone",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "plan",
"label": "Plan",
"kind": "string",
"piiClass": "",
"source": "api"
}
]
}{
"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
Get a record type's fields
Returns a type’s learned field definitions — the exact shape used to render structured inputs for records of that type.
GET
/
record-types
/
{type}
/
fields
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"name": "name",
"label": "Name",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "phone",
"label": "Phone",
"kind": "string",
"piiClass": "contact",
"source": "api"
},
{
"name": "plan",
"label": "Plan",
"kind": "string",
"piiClass": "",
"source": "api"
}
]
}{
"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.
Path Parameters
The object type's snake_case name (from listRecordTypes).