Organization
Last updated
Last updated
This API retrieves the list of organizations along with their basic information, such as organization name and the organization they belong to.
Endpoint: GET /organizations
Parameters:
Parameter | Description | Type | Require | Default |
---|---|---|---|---|
Example Request:
Example Response:
Response Fields:
This API retrieves the details of a specific organization by organization ID, including organization name and the organization it belongs to.
Endpoint: GET /organizations/:organization_id
Path Parameters:
Example Request:
Example Response:
Response Fields:
Field | Description | Type |
---|---|---|
Parameter | Description | Type | Require |
---|---|---|---|
Field | Descritpion | Type |
---|---|---|
ids
Fetch specific ids.
string
No
-
offset
The offset for pagination.
integer
No
0
limit
The maximum number of results per page.
integer
No
100
id
The unique identifier for the organization.
integer
name
The name of the organization.
string
belongs_to
The ID of the organization this organization belongs to.
integer
organization_id
The unique identifier for the organization.
integer
required
organization_id
The unique identifier for the organization.
integer
organization_name
The name of the organization.
string
belongs_to
The ID of the organization this organization belongs to.
integer