Companies API reference

Companies endpoints of the Quackback REST API: paths, parameters, request fields and responses.

This is the reference for the Companies endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

GET /companies: List companies
GET /companies/{companyId}: Get a company

List companies

GET /api/v1/companies

Returns a paginated list of companies with their member counts, ordered by name

Parameters

Name	In	Type	Required	Description
`search`	query	string	No	Search in name and domain
`company_id`	query	string	No	Exact match on the external reference (external ID). Unknown references return an empty list.
`tag_id`	query	string	No	Restrict to companies with at least one member carrying this user tag. Unknown or malformed IDs return an empty list.
`segment_id`	query	string	No	Restrict to companies with at least one member in this segment. Unknown or malformed IDs return an empty list.
`cursor`	query	string	No	Pagination cursor from previous response
`limit`	query	integer	No	Items per page (max 100)

Response 200: returns id, name, domain, externalId, plan, mrrCents, size, website, industry, source, customAttributes, memberCount, createdAt, updatedAt.

Get a company

GET /api/v1/companies/{companyId}

Returns a single company with its member count