https://api.katapult.io/core/v1/organizations/organization
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
organization_suspended
|
An organization was found from the arguments provided but it was suspended |
|
|
organization_not_activated
|
An organization was found from the arguments provided but it wasn't activated yet |
|
|
organization_not_found
|
No organization was found matching any of the criteria provided in the arguments |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
organization[id]
string
query
All 'organization[]' params are mutually exclusive, only one can be provided.
organization[sub_domain]
string
query
All 'organization[]' params are mutually exclusive, only one can be provided.
organization
object
id
string
uuid
string
name
string
sub_domain
string
infrastructure_domain
string
created_at
integer
activated_at
integer
suspended
boolean
managed
boolean
billing_name
string
address1
string
address2
string
address3
string
address4
string
postcode
string
vat_number
string
phone_number
string
currency
object
id
string
name
string
iso_code
string
symbol
string
country
country_state
{
"organization": {
"id": "string",
"uuid": "string",
"name": "string",
"sub_domain": "string",
"infrastructure_domain": "string",
"created_at": 0,
"activated_at": 0,
"suspended": true,
"managed": true,
"billing_name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"postcode": "string",
"vat_number": "string",
"phone_number": "string",
"currency": {
"id": "string",
"name": "string",
"iso_code": "string",
"symbol": "string"
},
"country": "string",
"country_state": "string"
}
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Left blank, a parameter is omitted from the request.