GET
/
v1
/
companies
/
:id
curl https://api.usertour.io/v1/companies/comp_123456789 \
-H 'Authorization: Bearer ak_123456789' \
-H 'Content-Type: application/json'
{
  "id": "comp_123456789",
  "object": "company",
  "attributes": {
    "name": "Acme Corporation",
    "industry": "Technology",
    "employee_count": 500,
    "subscription_tier": "enterprise",
    "billing_country": "US",
    "founded_at": "2020-01-01T00:00:00.000Z"
  },
  "createdAt": "2024-03-20T08:30:00.000Z",
  "users": null,
  "memberships": null
}

This endpoint retrieves a single company’s information from the system. You can use the expand query parameter to include related objects such as memberships and users in the response.

Path parameters

id
string

The unique identifier of the company to retrieve. This should match the ID format used in your system (e.g., comp_123456789).

Response

Returns the company object with its current state, including:

  • Company metadata and attributes
  • Creation timestamp
  • Related memberships and users (if expanded)
curl https://api.usertour.io/v1/companies/comp_123456789 \
-H 'Authorization: Bearer ak_123456789' \
-H 'Content-Type: application/json'
{
  "id": "comp_123456789",
  "object": "company",
  "attributes": {
    "name": "Acme Corporation",
    "industry": "Technology",
    "employee_count": 500,
    "subscription_tier": "enterprise",
    "billing_country": "US",
    "founded_at": "2020-01-01T00:00:00.000Z"
  },
  "createdAt": "2024-03-20T08:30:00.000Z",
  "users": null,
  "memberships": null
}