Twenty · Example Payload

Twenty List Companies

Example request and response for fetching a filtered, paginated list of companies.

CRMOpen SourceRESTGraphQLWebhooksSelf-HostedCompaniesPeopleOpportunitiesWorkflowsAI AgentsCustom Objects

Twenty List Companies is an example object payload from Twenty, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

{
  "title": "List Companies with Filtering and Pagination",
  "description": "Example request and response for fetching a filtered, paginated list of companies.",
  "request": {
    "method": "GET",
    "url": "https://api.twenty.com/rest/core/companies",
    "headers": {
      "Authorization": "Bearer <your-workspace-token>"
    },
    "queryParameters": {
      "filter": "name[ilike]:\"%acme%\"",
      "order_by": "createdAt[DescNullsLast]",
      "limit": "10",
      "depth": "1"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "data": {
        "companies": {
          "edges": [
            {
              "node": {
                "id": "3b5e1234-abcd-0000-0000-000000000001",
                "createdAt": "2026-06-12T12:00:00.000Z",
                "updatedAt": "2026-06-12T12:00:00.000Z",
                "deletedAt": null,
                "name": "Acme Corporation",
                "domainName": {
                  "primaryLinkUrl": "https://acme.com",
                  "primaryLinkLabel": "Acme",
                  "secondaryLinks": null
                },
                "annualRevenue": {
                  "amountMicros": 500000000000,
                  "currencyCode": "USD"
                },
                "address": {
                  "addressCity": "San Francisco",
                  "addressState": "CA",
                  "addressCountry": "US"
                }
              },
              "cursor": "eyJpZCI6IjNiNWUxMjM0LWFiY2QtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMSJ9"
            }
          ],
          "pageInfo": {
            "hasNextPage": false,
            "hasPreviousPage": false,
            "startCursor": "eyJpZCI6IjNiNWUxMjM0LWFiY2QtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMSJ9",
            "endCursor": "eyJpZCI6IjNiNWUxMjM0LWFiY2QtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMSJ9"
          },
          "totalCount": 1
        }
      }
    }
  }
}