GET
View my client account
Client space User accounts only For: Administrator · Permission: clients.retrieve Part of Client accounts.

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, organization_id, name, tax_registration_number, business_registration_number, address, city, country, logo_url, currency_code, currency_exponent, is_active, created_at, updated_at.

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: .

Response

200 - application/json

Resource.

id

Identifier of the client account (27-character KSUID string).

organization_id

Identifier of the organization the record belongs to.

name

Name of the client account, stored in lowercase.

tax_registration_number

Tax registration number of the client account; null when not set.

business_registration_number

Business registration number of the client account; null when not set.

address

Street address of the client account; null when not set.

city

City of the client account; null when not set.

country

Country of the client account as free text; null when not set.

logo_url

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

currency_code

3-character currency code of the client account, chosen when the client was created; it cannot be changed through this update.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

is_active
boolean

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

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).