The organization this key belongs to

GET

/organization

curl --request GET \
  --url https://api.usepayloom.com/api/v1/organization \
  --header 'Authorization: Bearer <token>'

• Production
• Staging (demo data, `plm_test_` keys)
• Sandbox, for building and testing an integration: its own database, `plm_test_` keys issued by Payloom (a `plm_live_` key is refused), no email delivered and nothing paid. The docs playground sends requests here

Authorizations

• ApiKey

Responses

200

OK

Media typeapplication/json

object

id

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

payout_mode

Who sends the pay. bank_file: the company pays from its own bank with Payloom’s bank file. payloom: Payloom pays from a funded account, which Payloom turns on after verification.

string

Allowed values: bank_file payloom

created_at

string format: date-time

Example

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

401

Missing, invalid, revoked or expired key.

Media typeapplication/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 idempotency_key_reuse idempotency_key_in_progress invalid_transition jurisdiction_unverified no_employees_in_jurisdiction kyc_not_verified plan_required filing_not_ready payment_file_refused gl_locked region_unavailable

message

required

string

details

object

key

additional properties

any

Example

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

429

Too many requests. Honour Retry-After.

Media typeapplication/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 idempotency_key_reuse idempotency_key_in_progress invalid_transition jurisdiction_unverified no_employees_in_jurisdiction kyc_not_verified plan_required filing_not_ready payment_file_refused gl_locked region_unavailable

message

required

string

details

object

key

additional properties

any

Example

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

Headers

Retry-After

integer

Seconds to wait.