Links
DOCUMENTS.VIEW. Requires linkableType + linkableId. Authorization: Bearer ak_.... Required scope: read:documents. Pass entityId query (must match the key’s entity). Session cookie auth with x-entity-id is also supported.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Query Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuiduuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/documents/document-links?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08&linkableType=string&linkableId=497f6eca-6276-4993-bfeb-53cbbbba6f08"[ {}]{ "error": "string"}{ "error": "string"}{ "error": "string"}DOCUMENTS.EDIT. Authorization: Bearer ak_.... Required scope: write:documents. Pass entityId query or JSON body (must match the key’s entity). Session cookie auth with x-entity-id is also supported.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Query Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/documents/document-links?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052", "linkableType": "string", "linkableId": "7cca18e0-f038-48b8-a601-8542a34fb1d9" }'{}{ "error": "string"}{ "error": "string"}{ "error": "string"}DOCUMENTS.EDIT. Query ?id= link UUID (must belong to entity). Authorization: Bearer ak_.... Required scope: write:documents. Pass entityId query or JSON body (must match the key’s entity). Session cookie auth with x-entity-id is also supported.
Authorization
bearerAuth Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....
In: header
Query Parameters
Entity UUID; must match the API key’s entity when using Bearer auth.
uuiduuidResponse Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/documents/document-links?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08&id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "deleted": true}{ "error": "string"}{ "error": "string"}{ "error": "string"}