List companies

GET

/companies

Companies in your organization, newest first.

Query parameters

pageintegermin 1
Page number, starting at 1.

Default: 1
limitintegermin 1max 100
Items per page.

Default: 20

Responses

200

A page of companies.

Body object

dataCompany[]required
- idstringrequiredpattern ^[0-9a-fA-F]{24}$
  A 24-character hex ID.
- namestringrequired
- websitestring | nullrequired
metaPaginationMetarequired
- totalintegerrequired
  Total number of matching items.
- pageintegerrequiredmin 1
- limitintegerrequiredmin 1max 100
- totalPagesintegerrequired
  ceil(total / limit). It is 0 when there are no results.
timestampinteger (int64)required
Server time in milliseconds since the Unix epoch.

Example

{
  "data": [
    {
      "id": "66f3a1c2e4b0a1d2c3e4f510",
      "name": "Acme Logistics",
      "website": "https://acme-logistics.example.com"
    },
    {
      "id": "66f3a1c2e4b0a1d2c3e4f511",
      "name": "Acme Retail",
      "website": null
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  },
  "timestamp": 1790330400000
}

400

The request is invalid. message is the first validation error.

Body Error

successbooleanrequired
Values: false
messagestringrequired
A human-readable error message.
timestampinteger (int64)required
Server time in milliseconds since the Unix epoch.

Example

{
  "success": false,
  "message": "limit must be between 1 and 100",
  "timestamp": 1790330400000
}

401

The API key is missing, malformed, invalid or revoked.

Body Error

successbooleanrequired
Values: false
messagestringrequired
A human-readable error message.
timestampinteger (int64)required
Server time in milliseconds since the Unix epoch.

{
  "success": false,
  "message": "API key is required. Send it as 'Authorization: Bearer <key>'",
  "timestamp": 1790330400000
}

403

API access is disabled for your organization (any endpoint), or, when creating an invite, your organization has no active subscription or no interview credits left.

Body Error

successbooleanrequired
Values: false
messagestringrequired
A human-readable error message.
timestampinteger (int64)required
Server time in milliseconds since the Unix epoch.

{
  "success": false,
  "message": "API access is not enabled for this organization",
  "timestamp": 1790330400000
}

429

Too many requests. Wait for Retry-After seconds (or the reset value in RateLimit), then retry.

Headers

RateLimitstring
Draft-7 rate limit state, e.g. limit=120, remaining=0, reset=42 (reset is in seconds).
RateLimit-Policystring
Draft-7 rate limit policy: the limit and the window in seconds.
Retry-Afterinteger
Seconds to wait before retrying.

Body Error

successbooleanrequired
Values: false
messagestringrequired
A human-readable error message.
timestampinteger (int64)required
Server time in milliseconds since the Unix epoch.

Example

{
  "success": false,
  "message": "Too many requests. Retry after the number of seconds in the RateLimit header.",
  "timestamp": 1790330400000
}