Organizations

Quick Navigation

• GET Organizations
• GET Organizations/{id}
• GET Organizations?name={name}

GET Organizations

Purpose

Returns a list of organizations to which the current user has permission.

Required Permissions

Asset Management (Read).

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        OrganizationID : string,
        Name : string,
        IsActive : bool
    },
    …
]

Response Codes

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.

GET Organizations/{id}

Purpose

Returns an organization by ID.

Required Permissions

• Current user has permission to the organization.
• Asset Management (Read).

URL Parameters

id: ID of the organization.

Request Body

None.

Response Body

Content-Type: application/json

{
    OrganizationID : string,
    Name : string,
    IsActive : bool
}

Response Codes

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.

GET Organizations?name={name}

Purpose

Returns an organization by name.

Required Permissions

• Current user has permission to the organization
• Asset Management (Read).

Query Parameters

name: Name of the organization.

Request Body

None.

Response Body

Content-Type: application/json

{
    OrganizationID : string,
    Name : string,
    IsActive : bool
}

Response Codes

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.