Skip to main content
POST
Read CRM fields, pipelines or lists

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Provider connection sid (in_cn_...).

Required string length: 18
Pattern: ^in_cn_

Body

application/json

Request body of read_provider_connection_crm_metadata.

kind
enum<string>
required

What to read: fields, pipelines, lists (attio lists, folk groups) or owners (reserved).

Available options:
fields,
pipelines,
owners,
lists
object
enum<string>

With kind fields: whose fields, a person's or a company's (required then).

Available options:
person,
company
group
string

With kind fields on folk: the group whose custom fields join the standard ones (a folk group id, grp_...); the other CRMs ignore it.

Required string length: 1 - 64

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required