Organization

Get Organization List

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:

ParameterDescriptionTypeRequireDefault

offset

The offset for pagination.

integer

No

0

limit

The maximum number of results per page.

integer

No

100

Example Request:

GET /organizations?offset=0&limit=10

Example Response:

[
    {
      "id": 1,
      "name": "Organization 1",
      "belongs_to": 0
    },
    {
      "id": 2,
      "name": "Organization 2",
      "belongs_to": 1
    }
]

Response Fields:

FieldDescriptionType

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


Get Organization Details

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:

ParameterDescriptionTypeRequire

organization_id

The unique identifier for the organization.

integer

required

Example Request:

GET /organizations/1

Example Response:

{
  "id": 1,
  "name": "Organization 1",
  "belongs_to": 0
}

Response Fields:

FieldDescritpionType

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