Get the business profile

GET

/business

const url = 'https://example.com/business';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/business \
  --cookie bottle.session_token=<bottle.session_token>

The business name, company number and registered office.

Authorizations

sessionCookie
tenant:read
apiKey
tenant:read

Responses

200

The profile

application/json

object

name

required

string

companyNumber

required

string | null

registeredAddress

required

object

line1

required

string

city

required

string | null

postcode

required

string

Example

{
  "name": "Acme Gas",
  "companyNumber": "01234567",
  "registeredAddress": {
    "line1": "1 Yard Lane",
    "city": "Kingston upon Thames",
    "postcode": "KT1 1EU"
  }
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}