Organizations

Quick Navigation

GET Organizations

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

Asset Management (Read).

None.

Content-Type: application/json

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

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.

GET Organizations/{id}

Returns an organization by ID.

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

id: ID of the organization.

None.

Content-Type: application/json

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

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.

GET Organizations?name={name}

Returns an organization by name.

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

name: Name of the organization.

None.

Content-Type: application/json

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

200 – Request successful. Organizations in the response body.

For more information, please see Common Response Codes.