Get an organisation by id

GET

/api/v1/organisations/{organisation_id}

curl --request GET \
  --url https://example.com/api/v1/organisations/f81d4fae-7dec-11d0-a765-00a0c91e6bf6 \
  --header 'Authorization: Bearer <token>'

Retrieves detailed information about a specific organisation. Restricted to superusers and managers of the organisation.

Authorizations

• oauth2
  compute:base

Parameters

Path Parameters

organisation_id

required

Array<number>

Example

f81d4fae-7dec-11d0-a765-00a0c91e6bf6

The ID of the organisation

Responses

default

On success

Media typeapplication/json

object

code

required

number format: int32

data

required

object

allowed_device_types

required

Array<string>

created_at

required

string format: date-time

id

required

Array<number>

managers

required

Array<object>

object

email

required

string

family_name

required

string

given_name

required

string

user_id

required

string

name

required

string

projects

required

Array<object>

object

allowed_device_types

required

Array<string>

id

required

Array<number>

name

required

string

priority_queue

required

string

queue_priority

required

string

updated_at

required

string format: date-time

message

required

string

pagination

required

object

total

required

number format: int64

status

required

string

Example

{
  "code": "200",
  "data": {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "projects": [
      {
        "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
      }
    ]
  },
  "message": "success",
  "status": "OK"
}