Method list
Статья создана
Retrieves the list of Organization resources.
HTTP request
GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/organizations
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
| pageToken | Page token. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. The maximum string length in characters is 100. |
| filter | A filter expression that filters resources listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on the Organization.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"organizations": [
{
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"title": "string",
"labels": "object"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| organizations[] | object An Organization resource. For more information, see Organization. |
| organizations[]. id |
string ID of the organization. |
| organizations[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
| organizations[]. name |
string Name of the organization. 3-63 characters long. |
| organizations[]. description |
string Description of the organization. 0-256 characters long. |
| organizations[]. title |
string Display name of the organization. 0-256 characters long. |
| organizations[]. labels |
object Resource labels as |
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |