GET
/
v1
/
companies
curl https://api.usertour.io/v1/companies \
-H 'Authorization: Bearer ak_123456789' \
-H 'Content-Type: application/json'

{
  "results": [
    {
      "id": "comp_123456789",
      "object": "company",
      "attributes": {
        "name": "Acme Corp",
        "domain": "acme.com",
        "industry": "Technology",
        "size": "100-500",
        "created_at": "2024-03-20T08:30:00.000Z"
      },
      "createdAt": "2024-03-20T08:30:00.000Z",
      "updatedAt": "2024-03-20T08:30:00.000Z"
    },
    {
      "id": "comp_987654321",
      "object": "company",
      "attributes": {
        "name": "TechStart Inc",
        "domain": "techstart.io",
        "industry": "Software",
        "size": "50-100",
        "created_at": "2024-03-19T15:45:00.000Z"
      },
      "createdAt": "2024-03-19T15:45:00.000Z",
      "updatedAt": "2024-03-19T15:45:00.000Z"
    }
  ],
  "next": "/v1/companies?limit=2&cursor=comp_987654321",
  "previous": null
}

This endpoint returns a paginated list of companies associated with your account. Each company object includes its attributes, relationships, and metadata.

​
Query parameters

​
limit
number
default:"20"

Specifies the maximum number of items to return in a single response. The value must be between 1 and 100. If not specified, defaults to 20 items per page.

​
cursor
string

Specifies the starting point for the next page of results. The response will include items that come after (but not including) the object with this ID. To get the next page, use the ID of the last item from your previous request. The easiest way is to use the list object’s cursor field. If not provided, the API will return items from the beginning of the list.

​
expand
string | string[]

See Expanding objects. Available options:

  • memberships: Include basic membership data for each company
  • memberships.user: Include both membership and associated user details
  • users: Include all users associated with the company
  • You can request multiple expansions: expand[]=memberships&expand[]=users

​
Response

Returns a list object containing an array of company objects in the results property. The response includes pagination information in the next and previous fields.

curl https://api.usertour.io/v1/companies \
-H 'Authorization: Bearer ak_123456789' \
-H 'Content-Type: application/json'

{
  "results": [
    {
      "id": "comp_123456789",
      "object": "company",
      "attributes": {
        "name": "Acme Corp",
        "domain": "acme.com",
        "industry": "Technology",
        "size": "100-500",
        "created_at": "2024-03-20T08:30:00.000Z"
      },
      "createdAt": "2024-03-20T08:30:00.000Z",
      "updatedAt": "2024-03-20T08:30:00.000Z"
    },
    {
      "id": "comp_987654321",
      "object": "company",
      "attributes": {
        "name": "TechStart Inc",
        "domain": "techstart.io",
        "industry": "Software",
        "size": "50-100",
        "created_at": "2024-03-19T15:45:00.000Z"
      },
      "createdAt": "2024-03-19T15:45:00.000Z",
      "updatedAt": "2024-03-19T15:45:00.000Z"
    }
  ],
  "next": "/v1/companies?limit=2&cursor=comp_987654321",
  "previous": null
}