Access & visibility
Allow customers.UpdateCompany on your API key. Resource read permissions: core:Company. Resource write 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.
idstringRequiredID 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.
dataCompanyOptionalThe fields to set.
Company
Company details7 fields
namestringOptionalCompany'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.
unsetarray of stringOptionalKeys of data to remove.
Each item: "name", "domain", "industry", "description", "owner_ref", "website", "org_number", "registry_country", "address", "postal_code", "city", "country", "phone", "tags", "product_lines", "profile".
expectedobjectOptionalPrior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.
Nested fields
namestring or objectOptionalCommit only if the previous name value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
domainstring or objectOptionalCommit only if the previous domain value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
industrystring or objectOptionalCommit only if the previous industry value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
descriptionstring or objectOptionalCommit only if the previous description value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
owner_refstring or objectOptionalCommit only if the previous owner_ref value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
websitestring or objectOptionalCommit only if the previous website value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
org_numberstring or objectOptionalCommit only if the previous org_number value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
registry_countrystring or objectOptionalCommit only if the previous registry_country value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
addressstring or objectOptionalCommit only if the previous address value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
postal_codestring or objectOptionalCommit only if the previous postal_code value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
citystring or objectOptionalCommit only if the previous city value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
countrystring or objectOptionalCommit only if the previous country value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
phonestring or objectOptionalCommit only if the previous phone value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
tagsarray of string or objectOptionalCommit only if the previous tags value matches; use $absent to require that this field is missing.
Nested fields
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
product_linesarray of object or objectOptionalCommit only if the previous product_lines value matches; use $absent to require that this field is missing.
Nested fields
Variant 1
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)
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
profileobject (2 variants)OptionalCommit only if the previous profile value matches; use $absent to require that this field is missing.
Nested fields
Variant 1
summarystringOptionalShort summary of the source information.
highlightsarray of stringOptionalKey points extracted from the source information.
$absent = true
$absenttrueRequiredRequire the field to be missing, rather than present with a null value.
Always true.
Update without losing changes
Send only the business fields you want to change in data; omitted fields stay unchanged. Use unset to remove an optional field. Setting a field to null is a different action and is allowed only when its schema permits null.
Use expected for a conditional update: supply the values you last read for the fields whose concurrent changes would matter. {"$absent": true} expects a missing field. A conflict means you must read the record again and decide how to reconcile the change. Keep the same idempotency key when retrying the original action; use a new key for a revised action.
Response
Returns 200 OK with a JSON body.
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.
itemCompanyRecordRequiredThe requested record, including its metadata and data fields.
CompanyRecord
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.
Errors & retries
Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.
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. Supply a stable Idempotency-Key containing 1–200 characters. |
| 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. Reuse the original Idempotency-Key. |
| 409 | conflict |
A supplied expected value no longer matches. Read the record again before deciding whether to retry. |
Next steps
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](/developers/reference/customers/ListCompanies). Use the record's top-level `id`, not a business field or account ID."
},
"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": [],
"additionalProperties": false,
"description": "The fields to set.",
"title": "Company"
},
"unset": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"domain",
"industry",
"description",
"owner_ref",
"website",
"org_number",
"registry_country",
"address",
"postal_code",
"city",
"country",
"phone",
"tags",
"product_lines",
"profile"
]
},
"description": "Keys of `data` to remove."
},
"expected": {
"type": "object",
"description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
"additionalProperties": false,
"properties": {
"name": {
"description": "Commit only if the previous name value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Company's display name; use org_number and registry_country for its registered identity."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"domain": {
"description": "Commit only if the previous domain value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Website hostname, without a scheme or path."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"industry": {
"description": "Commit only if the previous industry value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"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."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"description": {
"description": "Commit only if the previous description value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Business description recorded for this company."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"owner_ref": {
"description": "Commit only if the previous owner_ref value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"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."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"website": {
"description": "Commit only if the previous website value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Company website URL, including https://."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"org_number": {
"description": "Commit only if the previous org_number value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Organisation number from the company register, stored as text to preserve leading zeros."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"registry_country": {
"description": "Commit only if the previous registry_country value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"enum": [
"NO",
"SE"
],
"description": "Country of registration: NO for Norway or SE for Sweden."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"address": {
"description": "Commit only if the previous address value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Street address, including building or unit when applicable."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"postal_code": {
"description": "Commit only if the previous postal_code value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Postal code as text, preserving leading zeros."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"city": {
"description": "Commit only if the previous city value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Postal town or city."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"country": {
"description": "Commit only if the previous country value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Country associated with the address or record."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"phone": {
"description": "Commit only if the previous phone value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"type": "string",
"description": "Phone number including its country calling code."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"tags": {
"description": "Commit only if the previous tags value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"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."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"product_lines": {
"description": "Commit only if the previous product_lines value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"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."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
},
"profile": {
"description": "Commit only if the previous profile value matches; use $absent to require that this field is missing.",
"anyOf": [
{
"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."
},
{
"type": "object",
"properties": {
"$absent": {
"type": "boolean",
"const": true,
"description": "Require the field to be missing, rather than present with a null value."
}
},
"required": [
"$absent"
],
"additionalProperties": false
}
]
}
}
}
},
"required": [
"id"
],
"additionalProperties": false,
"examples": [
{
"id": "e_company_example",
"data": {
"city": "Bergen"
},
"expected": {
"city": "Oslo"
}
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"item": {
"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,
"description": "The requested record, including its metadata and data fields.",
"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": "Bergen"
}
}
}
]
}