A valid request URL is required to generate request examples{
"data": {
"name": "contacts",
"label": "Contact",
"fields": [
{
"name": "email",
"type": "string",
"nullable": true,
"pii": "contact"
},
{
"name": "firstname",
"type": "string",
"nullable": true
},
{
"name": "phone",
"type": "string",
"nullable": true,
"pii": "contact"
}
],
"edges": [
{
"name": "associatedDeals",
"target": "deals",
"cardinality": "to_many"
}
],
"operations": [
"search_contacts",
"get_contact",
"create_contact"
]
}
}{
"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>"
}
]
}Get one object's detail
Returns one object’s full detail: its fields (type, whether it’s required, allowed values, relationship target, and whether it’s sensitive), its operations, and its relationships to other objects. Returns 404 for an unknown object.
A valid request URL is required to generate request examples{
"data": {
"name": "contacts",
"label": "Contact",
"fields": [
{
"name": "email",
"type": "string",
"nullable": true,
"pii": "contact"
},
{
"name": "firstname",
"type": "string",
"nullable": true
},
{
"name": "phone",
"type": "string",
"nullable": true,
"pii": "contact"
}
],
"edges": [
{
"name": "associatedDeals",
"target": "deals",
"cardinality": "to_many"
}
],
"operations": [
"search_contacts",
"get_contact",
"create_contact"
]
}
}{
"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.
- Token URL
- /api/v1/api-keys
Path Parameters
The integration provider (connector). One of the supported connector slugs: native providers (google_calendar, google_sheets, calendly, hubspot, ``, square, opentable, shopify), SQL databases (postgres, mysql), the universal Zapier MCP fallback (zapier), or Composio (composio).
google_calendar, google_sheets, calendly, hubspot, square, opentable, shopify, postgres, mysql, zapier, composio The object api-name.
Response
The object detail.
The object's full detail: name, label, fields (each with type, nullable, cardinality, enum values, relationship target, PII class), operations, and outgoing relationship edges. An ABSTRACT object also carries abstract:true, abstractKind, and possibleTypes.