Get company — Brigg developers

Access & visibility

Allow customers.GetCompany 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.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:Company record. Find it with customers.ListCompanies. Use the record's top-level id, not a business field or account ID.

Response

Returns 200 OK with a JSON body.

item: null means there is no matching record visible to this caller. It does not reveal whether an inaccessible record exists.

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.

itemCompanyRecordRequired

null when no such record

CompanyRecord

idstringRequired

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_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

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.

privatebooleanRequired

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.

dataCompanyRequired

The record's fields.

Company

Company details7 fields

namestringRequired

Company's display name; use org_number and registry_country for its registered identity.

domainstringOptional

Website hostname, without a scheme or path.

industrystringOptional

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.

descriptionstringOptional

Business description recorded for this company.

websitestringOptional

Company website URL, including https://.

org_numberstringOptional

Organisation number from the company register, stored as text to preserve leading zeros.

registry_countrystringOptional

Country of registration: NO for Norway or SE for Sweden.

Allowed: "NO", "SE".

Contact information5 fields

addressstringOptional

Street address, including building or unit when applicable.

postal_codestringOptional

Postal code as text, preserving leading zeros.

citystringOptional

Postal town or city.

countrystringOptional

Country associated with the address or record.

phonestringOptional

Phone number including its country calling code.

Relationships and commercial terms4 fields

owner_refstringOptional

ID 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 stringOptional

Stable 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 objectOptional

Products or services agreed with this company, including quantity, price and billing frequency.

Item fields

product_refstringOptional

Product record ID.

namestringRequired

Display name.

descriptionstringOptional

Descriptive text.

quantitynumberOptional

Number of units. May be fractional when the product allows it.

Minimum: 0.

unitstringOptional

Unit used for the quantity, such as hours or items.

unit_price_oreintegerOptional

Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.

agreed_atnumberOptional

Time the commercial terms were agreed, in Unix milliseconds.

agreed_deal_refstringOptional

Deal record ID.

revenue_typestringOptional

Whether this amount is charged once or repeats monthly, quarterly or annually.

Allowed: "one_time", "monthly", "quarterly", "annual".

start_datestringOptional

ISO date (YYYY-MM-DD)

end_datestringOptional

ISO date (YYYY-MM-DD)

profileobjectOptional

Generated or supplied company profile, with a summary and key facts.

Nested fields

summarystringOptional

Short summary of the source information.

highlightsarray of stringOptional

Key points extracted from the source information.

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.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Company` record. Find it with [customers.ListCompanies](/reference/customers/ListCompanies). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_company_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "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](/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](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/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,
      "description": "null when no such record",
      "title": "CompanyRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "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"
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.GetCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_company_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/customers.GetCompany", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_company_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetCompany",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.GetCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_company_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.GetCompany", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_company_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetCompany",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "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"
    }
  }
}

Illustrative values, not a live response.

A missing or inaccessible record returns item: null. Do not treat this as proof that a record exists for another member.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.GetCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_company_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/customers.GetCompany", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_company_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetCompany",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.GetCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_company_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.GetCompany", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_company_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GetCompany",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": null
}

Illustrative values, not a live response.