Hub 2020.1 Help

Get All Organizations

Request

GET <REST API URL>/organizations?fields=string&$skip=int&$top=int&query=string&orderBy=string

Parameter

Description

fields

Optional. Returns only the specified subset of the fields for each Organization. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of Organizations to skip before returning the first one.

$top

Optional. Lets you set the maximum number of Organizations to return.

query

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Organizations, the following fields and tuples are supported:

after: instant — Returns organizations that were created after the specified moment

before: instant — Returns organizations that were created before the specified moment

has: project — Returns organizations that contain at least one project

id: value — Organization with the given ID

name: organizationName — Returns organization with the specified name

project: project — Returns organizations that immediately contain the given project

orderBy

Optional. Returns the list of Organizations sorted by a specified field. See Sorting Syntax for details. Organizations support ordering by the following fields: creationTime, name

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "organizations": [organization, ...] }
Last modified: 25 March 2020