Returns information about a specific organization.
If successful, this endpoint will return a 200 OK status.
One of the following scopes are required to use this endpoint.
The following arguments are supported for this endpoint.
| Name | Type | Default Value |
|---|---|---|
|
organization Required |
Organization Lookup | None |
The following errors may occur during this request.
| Details | HTTP status |
|---|---|
|
An organization was found from the arguments provided but it wasn't activated yet |
403 Forbidden |
|
No organization was found matching any of the criteria provided in the arguments |
404 Not Found |
|
An organization was found from the arguments provided but it was suspended |
403 Forbidden |
When the request is successful, you can expect an object matching the specification below to be returned.
{ organization: Organization { id: String name: String sub_domain: String infrastructure_domain: String created_at: Unix Timestamp activated_at: Unix Timestamp? suspended: Boolean managed: Boolean billing_name: String? address1: String? address2: String? address3: String? address4: String? postcode: String? vat_number: String? phone_number: String? currency: Currency { id: String name: String iso_code: String symbol: String } country: Country? { id: String name: String iso_code2: String iso_code3: String time_zone: String? eu: Boolean } country_state: CountryState? { id: String name: String code: String country: Country { id: String name: String iso_code2: String iso_code3: String time_zone: String? eu: Boolean } } } }