get /api/organizations/{id}
Retrieves a Organization resource.
Returns a single organization by id, including its owners and members. You must be a member of the organization to read it.
Path parameters
| Name | Type | Required | Description |
|---|
id | string | required | Organization identifier |
Response
200 - The organization with its owners and members
| Property | Type | Required | Description |
|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
id | string | null | - | |
name | string | - | |
created_at | string | - | |
updated_at | string | - | |
owners | Member[] | - | |
Show owners fields| Property | Type | Required | Description |
|---|
@context | object | - | | @id | string | required | | @type | string | required | | id | string | - | | email | string | - | | name | string | null | - | | role | string | - | | joined_at | string | - | |
|
members | Member[] | - | |
Show members fields| Property | Type | Required | Description |
|---|
@context | object | - | | @id | string | required | | @type | string | required | | id | string | - | | email | string | - | | name | string | null | - | | role | string | - | | joined_at | string | - | |
|
| Property | Type | Required | Description |
|---|
id | string | null | - | |
name | string | - | |
created_at | string | - | |
updated_at | string | - | |
owners | Member[] | - | |
Show owners fields| Property | Type | Required | Description |
|---|
id | string | - | | email | string | - | | name | string | null | - | | role | string | - | | joined_at | string | - | |
|
members | Member[] | - | |
Show members fields| Property | Type | Required | Description |
|---|
id | string | - | | email | string | - | | name | string | null | - | | role | string | - | | joined_at | string | - | |
|
Errors
403 - Forbidden
| Property | Type | Required | Description |
|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | number | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |
| Property | Type | Required | Description |
|---|
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | number | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |
404 - Not found
| Property | Type | Required | Description |
|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | number | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |
| Property | Type | Required | Description |
|---|
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | number | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |