Skip to content

Get details of a single organization

GET
/api/v2/organizations/{organization}

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

Example
test-org

Responses

200

The request has succeeded.

object
name
required

Organization name

string
Test Organization
machine_name
required

Organization machine name

string
test-org
type

Organization type

string
business
region

Organization region

string
au
subscription

Subscription type

string
professional
created_at

Creation timestamp

string format: date-time
2024-01-15T10:30:00Z
updated_at

Last update timestamp

string format: date-time
2024-10-10T14:20:00Z
{
"name": "Test Organization",
"machine_name": "test-org",
"type": "business",
"region": "au",
"subscription": "professional",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-10-10T14:20:00Z"
}

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
"message": "The requested resource was not found",
"error": true
}

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
"message": "The requested resource was not found",
"error": true
}

404

Organization not found.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
"message": "The requested resource was not found",
"error": true
}