Twenty Core API
The Twenty Core API provides REST and GraphQL endpoints for CRUD operations on all CRM records including companies, people, opportunities, notes, tasks, and any custom objects defined in a workspace. Both interfaces support batch operations of up to 60 records per request, filtering, and relation traversal. GraphQL additionally supports batch upsert using plural object names. Authentication is via bearer token generated from the workspace settings. The API schema is per-tenant and adapts automatically as custom objects are added.
Documentation
Specifications
OpenAPI
https://api.twenty.com/open-api/core
OpenAPI
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/openapi/twenty-core-api-openapi.yml
Schemas & Data
JSONSchema
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/json-schema/twenty-company.json
JSONSchema
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/json-schema/twenty-person.json
JSONSchema
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/json-schema/twenty-opportunity.json
Other Resources
Examples
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/examples/twenty-create-company.json
Examples
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/examples/twenty-list-companies.json
Examples
https://raw.githubusercontent.com/api-evangelist/twenty/refs/heads/main/examples/twenty-create-custom-object.json