Access & visibility
Allow customers.ListCompanies on your API key. Resource read permissions: core:Company.
Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.
Request fields
Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
filtersarray of objectOptionalConditions the row must ALL satisfy.
Item fields
fieldstringRequireddata.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.
Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.name", "data.domain", "data.industry", "data.description", "data.owner_ref", "data.website", "data.org_number", "data.registry_country", "data.address", "data.postal_code", "data.city", "data.country", "data.phone", "data.tags", "data.product_lines", "data.profile".
opstringRequiredComparison operator. Use in with an array, or omit value for is_empty and is_not_empty.
Allowed: "eq", "neq", "contains", "starts_with", "gt", "gte", "lt", "lte", "in", "has", "is_empty", "is_not_empty".
valueJSON valueOptionalThe comparison value; an array for in; omitted for is_empty / is_not_empty.
sortobjectOptionalSort order for the results. Defaults to updated_at descending, with id as a tie-breaker.
Nested fields
fieldstringRequireddata.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.
Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.name", "data.domain", "data.industry", "data.description", "data.owner_ref", "data.website", "data.org_number", "data.registry_country", "data.address", "data.postal_code", "data.city", "data.country", "data.phone", "data.tags", "data.product_lines", "data.profile".
directionstringOptionalSort direction: asc for ascending or desc for descending.
Allowed: "asc", "desc".
limitintegerOptionalMaximum number of results to return in this page. Continue with next_cursor when returned.
Default: 100. Minimum: 1.
cursorstringOptionalThe next_cursor of the previous page.
Filtering and sorting
All conditions are combined with AND. Address business fields as data.<field>, and record metadata as id, created_at, updated_at, created_by or private. A field path names one field; it does not traverse nested objects.
| Operator | Meaning | Value |
|---|---|---|
eq |
Equal to a scalar | String, number, boolean or null |
neq |
Not equal; missing values also match | String, number, boolean or null |
contains |
Case-insensitive text contains | String; % and _ are literal characters |
starts_with |
Case-insensitive text prefix | String |
gt, gte |
Greater than / at least | Number or string appropriate to the field |
lt, lte |
Less than / at most | Number or string appropriate to the field |
in |
Equal to any supplied scalar | Nonempty array of strings, numbers, booleans or null |
has |
Array contains a string | One string; does not match properties inside array objects |
is_empty |
Missing, null, empty string or empty array | Omit value |
is_not_empty |
Has a nonempty value | Omit value |
Match the stored field's type. Numeric business timestamps take Unix milliseconds; date-only business fields take YYYY-MM-DD. The record metadata fields created_at and updated_at also accept ISO timestamps for ordered comparisons.
Sorting defaults to updated_at descending. If you supply sort.field without sort.direction, direction is desc. The record ID breaks ties; missing values sort last.
Response
Returns 200 OK with a JSON body.
An empty items array means this page contains no matching visible results. Follow next_cursor when present.
Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.
itemsarray of CompanyRecordRequiredRecords visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned.
Item fields
idstringRequiredStable core:Company record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.
created_atnumberRequiredTime the record was created, in Unix milliseconds.
updated_atnumberRequiredTime the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.
created_bystring or nullRequiredAccount that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.
privatebooleanRequiredTrue for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.
dataCompanyRequiredThe record's fields.
Company
Company details7 fields
namestringRequiredCompany's display name; use org_number and registry_country for its registered identity.
domainstringOptionalWebsite hostname, without a scheme or path.
industrystringOptionalIndustry classification. Send the stored enum value; the English label is for display only. Values: bygg — Construction; handel — Retail and wholesale; konsulent — Consulting; it — Information technology; helse — Healthcare; restaurant — Restaurants; eiendom — Real estate; transport — Transport; finans — Finance; utdanning — Education; industri — Manufacturing; offentlig — Public sector; annet — Other.
descriptionstringOptionalBusiness description recorded for this company.
websitestringOptionalCompany website URL, including https://.
org_numberstringOptionalOrganisation number from the company register, stored as text to preserve leading zeros.
registry_countrystringOptionalCountry of registration: NO for Norway or SE for Sweden.
Allowed: "NO", "SE".
Contact information5 fields
addressstringOptionalStreet address, including building or unit when applicable.
postal_codestringOptionalPostal code as text, preserving leading zeros.
citystringOptionalPostal town or city.
countrystringOptionalCountry associated with the address or record.
phonestringOptionalPhone number including its country calling code.
Relationships and commercial terms4 fields
owner_refstringOptionalID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.
tagsarray of stringOptionalStable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.
product_linesarray of objectOptionalProducts or services agreed with this company, including quantity, price and billing frequency.
Item fields
product_refstringOptionalProduct record ID.
namestringRequiredDisplay name.
descriptionstringOptionalDescriptive text.
quantitynumberOptionalNumber of units. May be fractional when the product allows it.
Minimum: 0.
unitstringOptionalUnit used for the quantity, such as hours or items.
unit_price_oreintegerOptionalPrice per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.
agreed_atnumberOptionalTime the commercial terms were agreed, in Unix milliseconds.
agreed_deal_refstringOptionalDeal record ID.
revenue_typestringOptionalWhether this amount is charged once or repeats monthly, quarterly or annually.
Allowed: "one_time", "monthly", "quarterly", "annual".
start_datestringOptionalISO date (YYYY-MM-DD)
end_datestringOptionalISO date (YYYY-MM-DD)
profileobjectOptionalGenerated or supplied company profile, with a summary and key facts.
Nested fields
summarystringOptionalShort summary of the source information.
highlightsarray of stringOptionalKey points extracted from the source information.
next_cursorstringOptionalPass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results.
Pagination
Pass next_cursor from the response as cursor on the next request. Keep the same filters, sort and acting identity. Stop when next_cursor is absent; do not infer completion from the number of items. The default page size is 100; limit must be a positive integer.
Pagination is a live view, not a snapshot. Changes between pages can move records across page boundaries. Upsert by record ID rather than appending blindly. For recurring synchronization, use an overlapping update window and deduplicate records. Periodically reconcile IDs to detect deletions. Resource webhooks can supplement synchronization for eligible workspace-shared records only: they do not export private or project-scoped records. Personal data still needs polling and reconciliation.
const query = {
"filters": [
{
"field": "data.industry",
"op": "eq",
"value": "konsulent"
}
],
"sort": {
"field": "data.name",
"direction": "asc"
},
"limit": 10
};
let cursor;
do {
const response = await fetch("https://api.brigg.app/v1/operations/customers.ListCompanies", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
});
const page = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
for (const item of page.items) {
console.log(item); // Process or upsert each result.
}
cursor = page.next_cursor;
} while (cursor);Errors & retries
This operation reads data. It needs no idempotency key and can be retried after a transient failure.
For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.
| HTTP status | Code | What to do |
|---|---|---|
| 400 | invalid_json |
Send a JSON object with Content-Type: application/json. |
| 400 | invalid_input |
Check the request fields and types. |
| 401 | invalid_key |
The workspace API key is missing, invalid or revoked. |
| 403 | forbidden |
Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | not_found |
The requested operation or resource is not available to this credential. |
| 429 | rate_limited |
Wait for Retry-After before retrying. |
| 400 | cursor_invalid |
Restart pagination with no cursor. |
| 400 | cursor_mismatch |
Use the cursor with the original filters, sort order and credential. |
Next steps
JSON schemas
Use the complete schemas for validation or client generation.
Full request JSON schema
{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
"enum": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data.name",
"data.domain",
"data.industry",
"data.description",
"data.owner_ref",
"data.website",
"data.org_number",
"data.registry_country",
"data.address",
"data.postal_code",
"data.city",
"data.country",
"data.phone",
"data.tags",
"data.product_lines",
"data.profile"
]
},
"op": {
"type": "string",
"enum": [
"eq",
"neq",
"contains",
"starts_with",
"gt",
"gte",
"lt",
"lte",
"in",
"has",
"is_empty",
"is_not_empty"
],
"description": "Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty."
},
"value": {
"description": "The comparison value; an array for `in`; omitted for is_empty / is_not_empty."
}
},
"required": [
"field",
"op"
],
"additionalProperties": false
},
"description": "Conditions the row must ALL satisfy."
},
"sort": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
"enum": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data.name",
"data.domain",
"data.industry",
"data.description",
"data.owner_ref",
"data.website",
"data.org_number",
"data.registry_country",
"data.address",
"data.postal_code",
"data.city",
"data.country",
"data.phone",
"data.tags",
"data.product_lines",
"data.profile"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort direction: asc for ascending or desc for descending."
}
},
"required": [
"field"
],
"additionalProperties": false,
"description": "Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker."
},
"limit": {
"type": "integer",
"minimum": 1,
"default": 100,
"description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
},
"cursor": {
"type": "string",
"description": "The `next_cursor` of the previous page."
}
},
"additionalProperties": false,
"examples": [
{
"filters": [
{
"field": "data.industry",
"op": "eq",
"value": "konsulent"
}
],
"sort": {
"field": "data.name",
"direction": "asc"
},
"limit": 10
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable core:Company record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
},
"created_at": {
"type": "number",
"description": "Time the record was created, in Unix milliseconds."
},
"updated_at": {
"type": "number",
"description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
},
"created_by": {
"type": [
"string",
"null"
],
"description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
},
"private": {
"type": "boolean",
"description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Company's display name; use org_number and registry_country for its registered identity."
},
"domain": {
"type": "string",
"description": "Website hostname, without a scheme or path."
},
"industry": {
"type": "string",
"enum": [
"bygg",
"handel",
"konsulent",
"it",
"helse",
"restaurant",
"eiendom",
"transport",
"finans",
"utdanning",
"industri",
"offentlig",
"annet"
],
"description": "Industry classification. Send the stored enum value; the English label is for display only. Values: `bygg` — Construction; `handel` — Retail and wholesale; `konsulent` — Consulting; `it` — Information technology; `helse` — Healthcare; `restaurant` — Restaurants; `eiendom` — Real estate; `transport` — Transport; `finans` — Finance; `utdanning` — Education; `industri` — Manufacturing; `offentlig` — Public sector; `annet` — Other."
},
"description": {
"type": "string",
"description": "Business description recorded for this company."
},
"owner_ref": {
"type": "string",
"description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/developers/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
},
"website": {
"type": "string",
"description": "Company website URL, including https://."
},
"org_number": {
"type": "string",
"description": "Organisation number from the company register, stored as text to preserve leading zeros."
},
"registry_country": {
"type": "string",
"enum": [
"NO",
"SE"
],
"description": "Country of registration: NO for Norway or SE for Sweden."
},
"address": {
"type": "string",
"description": "Street address, including building or unit when applicable."
},
"postal_code": {
"type": "string",
"description": "Postal code as text, preserving leading zeros."
},
"city": {
"type": "string",
"description": "Postal town or city."
},
"country": {
"type": "string",
"description": "Country associated with the address or record."
},
"phone": {
"type": "string",
"description": "Phone number including its country calling code."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Stable tag keys, not labels. Use [List tag vocabularies](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/reference/customers/ListTags) for its key/label pairs."
},
"product_lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_ref": {
"type": "string",
"description": "Product record ID."
},
"name": {
"type": "string",
"description": "Display name."
},
"description": {
"type": "string",
"description": "Descriptive text."
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units. May be fractional when the product allows it."
},
"unit": {
"type": "string",
"description": "Unit used for the quantity, such as hours or items."
},
"unit_price_ore": {
"type": "integer",
"description": "Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only."
},
"agreed_at": {
"type": "number",
"description": "Time the commercial terms were agreed, in Unix milliseconds."
},
"agreed_deal_ref": {
"type": "string",
"description": "Deal record ID."
},
"revenue_type": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"annual"
],
"description": "Whether this amount is charged once or repeats monthly, quarterly or annually."
},
"start_date": {
"type": "string",
"description": "ISO date (YYYY-MM-DD)"
},
"end_date": {
"type": "string",
"description": "ISO date (YYYY-MM-DD)"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Products or services agreed with this company, including quantity, price and billing frequency."
},
"profile": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "Short summary of the source information."
},
"highlights": {
"type": "array",
"items": {
"type": "string"
},
"description": "Key points extracted from the source information."
}
},
"additionalProperties": false,
"description": "Generated or supplied company profile, with a summary and key facts."
}
},
"required": [
"name"
],
"additionalProperties": false,
"description": "The record's fields.",
"title": "Company"
}
},
"required": [
"id",
"created_at",
"updated_at",
"created_by",
"private",
"data"
],
"additionalProperties": false,
"title": "CompanyRecord"
},
"description": "Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned."
},
"next_cursor": {
"type": "string",
"description": "Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results."
}
},
"required": [
"items"
],
"additionalProperties": false,
"examples": [
{
"items": [
{
"id": "e_company_example",
"created_at": 1794301200000,
"updated_at": 1794301200000,
"created_by": "a_example",
"private": false,
"data": {
"name": "Example Consulting",
"industry": "konsulent",
"website": "https://example.com",
"city": "Oslo"
}
}
]
}
]
}