Skip to main content
Companies

List contacts attached to a company

Returns all contacts (customers) attached to a specific company.

GET
/v2/companies/{id}/contacts

Only returns contacts with type "customer" that have the company in their companyIds array. Uses cursor-based pagination.

Path Parameters

  • id - The Featurebase internal ID of the company (MongoDB ObjectId)

Query Parameters

  • limit - Number of contacts to return (1-100, default: 10)
  • cursor - Opaque cursor from a previous response for pagination

Response Structure

The response includes:

  • object - Always "list"
  • data - Array of contact objects
  • nextCursor - Cursor for the next page (null if no more results)

Example Response

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "id": "507f1f77bcf86cd799439011",
      "userId": "usr_12345",
      "email": "john@acme.com",
      "name": "John Doe",
      "type": "customer",
      "companies": [...],
      "createdAt": "2025-01-01T12:00:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
}

Error Responses

  • 404 Not Found - Company with the specified ID does not exist

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

The Featurebase internal ID of the company (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

Query Parameters

limitintegerquerydefault:10

A limit on the number of contacts to be returned, between 1 and 100.

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

data(object | null)[]required

Array of contacts

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team