GET
View my company
Company space User accounts only For: Administrator · Permission: companies.retrieve Conditions
  • Agent accounts are refused.
Part of Company profile, settings and currencies.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, city, tax_registration_number, business_registration_number, address, working_hours, country, is_active, logo_url, subscription_activated_at, trial_ended_at, next_billing_at, activated_at, owner_id, cash_account_id, created_at, updated_at, parent.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: settings.

Response

200 - application/json

Resource.

id

Identifier of the company (27-character KSUID string).

name

Name of the company, stored in lowercase.

city

City of the company; null when not set.

tax_registration_number

Tax registration number of the company; null when not set.

business_registration_number

Business registration number of the company; null when not set.

address

Street address of the company; null when not set.

working_hours
object | null

Opening hours of the company, as an object keyed by weekday (monday to sunday) holding lists of HH:MM-HH:MM ranges, plus an optional exceptions object keyed by date (YYYY-MM-DD or MM-DD). When set, the company can only be used within these hours, in the company's time zone. Null when not set.

country

Country of the company as free text; null when not set. The coded country used for taxes is a separate field set on update.

is_active
boolean

Whether the company is active. An organization turns it on or off with the activate and deactivate actions.

logo_url

Public URL of the stored logo image, or null when no logo is set.

subscription_activated_at

Date and time the company's subscription was activated (ISO 8601); null when never activated. Not set by this API.

trial_ended_at

Date and time the company's trial ended or ends (ISO 8601); null when not set. Not set by this API.

next_billing_at

Date and time of the next billing (ISO 8601); null when not set. Not set by this API.

activated_at

Date and time the company was activated (ISO 8601). Set to the creation time when an organization creates the company.

owner_id

Identifier of the member who owns the company (27-character KSUID string); the creator when an organization creates the company.

cash_account_id

Identifier of the accounting cash account of the company (27-character KSUID string), created when its books are opened; null if not yet created. It is an account of the company's books, not a cash register's ledger account.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

parent
string | null
settings
object

Settings of the company (time zone, currency, rounding, default tax and discount rules). Rendered only when the include is selected, or in the role assignment answers.