The organization this key belongs to

GET

/organization

const url = 'https://api.usepayloom.com/api/v1/organization';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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://api.usepayloom.com/api/v1/organization \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKey

Responses

200

application/json

object

string format: uuid

object

string

Allowed value: organization

name

string

country_code

string

nullable

default_currency

string

status

string

Allowed values: active suspended deactivated

kyc_status

Payroll cannot be calculated until this is verified.

string

created_at

string format: date-time

Example

{
  "object": "organization",
  "status": "active"
}

401

Missing, invalid, revoked or expired key.

application/json

object

error

object

code

required

string

Allowed values: missing_token invalid_token revoked expired insufficient_scope organization_not_operable not_found invalid_request validation_failed rate_limited

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "missing_token"
  }
}

429

Too many requests. Honour Retry-After.

application/json

object

error

object

code

required

string

Allowed values: missing_token invalid_token revoked expired insufficient_scope organization_not_operable not_found invalid_request validation_failed rate_limited

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "missing_token"
  }
}

Headers

Retry-After

integer

Seconds to wait.