GET
/v1/definitionsList the pages (leads, deals, merchants, lenders, contacts, tasks…) and their keys
Every record page in the workspace — leads, deals, contacts and any custom page — with its key, statuses and views. Pass summary=true to list the pages without their columns; read ONE page's column ids with get_definitions_key before listing or changing its rows.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
summaryquery · booleanoptional
Responses
200application/json
the action's answer
{
"data": [
{
"access": "string",
"columnCount": 1,
"columns": [
{
"alignEnd": true,
"calculation": "string",
"config": {
"bands": [
{
"tone": "string",
"upTo": 1.5
}
],
"definitionKey": "string",
"groupColumnId": "",
"labelColumnId": "",
"object": "string",
"relationColumnId": "",
"sumColumnId": ""
},
"defaultEnabled": true,
"id": "",
"kind": "string",
"label": "string",
"minWidth": 1.5,
"options": [
{
"groupLabel": "string",
"id": "",
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
],
"position": 1.5,
"priority": 1.5,
"source": "string",
"starred": true
}
],
"createdAt": "string",
"icon": "string",
"id": "",
"key": "string",
"name": "string",
"object": "string",
"pack": "string",
"position": 1.5,
"purpose": "string",
"recordsEnabled": true,
"statuses": [
{
"groupId": "",
"groupLabel": "string",
"id": "",
"isActive": true,
"isTerminal": true,
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
],
"tagsEnabled": true,
"templateKey": "string",
"updatedAt": "string",
"view": "string",
"views": [
{
"columnIds": [
"string"
],
"crmUserId": 1,
"filter": {},
"id": "",
"key": "string",
"label": "string",
"position": 1.5,
"scope": "string",
"sort": {}
}
]
}
]
}dataarray<>required
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired