---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
alternate:
  - https://yandex.ru/dev/api360/doc/ru/federations/get-organizations.md
  - href: https://yandex.ru/dev/api360/doc/ru/federations/get-organizations.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/dev/api360/doc/ru/llms.txt?revision=r22091678
    rel: describedby
sourcePath: docs/dev/api360/concepts/gw/federations/get-organizations.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/api360/doc/ru/llms.txt?revision=r22091678

<!-- source: ru/openapi/v1directoryfederationsfederation_idorganizations-get.md -->
<div class="openapi">

# Получение списка организаций федерации

<!-- markdownlint-disable-file -->

Возвращает список организаций федерации и статус участия каждой из них. Запрос выполняется от имени организации, указанной в заголовке `X-Yandex360-Org-Id`.

Требуется одно из разрешений:
- `directory:read_federations` — чтение данных о федерациях;
- `directory:write_federations` — управление федерациями.

Отправить запрос может администратор организации или сотрудник с ролью **Менеджер федераций**.


## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://cloud-api.yandex.net/v1/directory/federations/{federation_id}/organizations
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_federation_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор федерации (UUID).

_Pattern:_{.json-schema-reset .json-schema-assertion} `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Query parameters

#|
|| **Name** | **Description** ||
||

_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Максимальное количество записей в ответе. Значение по умолчанию — `100`, максимальное — `1000`.

_Default:_{.json-schema-reset .json-schema-value} `100`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `1000`
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Смещение от начала списка. Значение по умолчанию — `0`.

_Default:_{.json-schema-reset .json-schema-value} `0`

_Min value:_{.json-schema-reset .json-schema-assertion} `0`
{.table-cell}
||
||

_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Порядок сортировки: по `membership_id`, `created_at` или `updated_at`. Чтобы отсортировать по убыванию, добавьте минус перед названием поля, например `sort=-created_at,membership_id`.


_Pattern:_{.json-schema-reset .json-schema-assertion} `^(-?(membership_id&#124;created_at&#124;updated_at)(,-?(membership_id&#124;created_at&#124;updated_at))*)?$`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Статусы участия, по которым фильтруется список: `requested`, `accepted`, `rejected` или `terminated`.

Несколько статусов перечисляются через запятую без пробела, например `status=accepted,requested`. Если параметр не задан, возвращаются все записи, доступные по правам.


_Pattern:_{.json-schema-reset .json-schema-assertion} `^((requested&#124;accepted&#124;rejected&#124;terminated)(,(requested&#124;accepted&#124;rejected&#124;terminated))*)?$`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Headers

#|
|| **Name** | **Description** ||
||

_X-Yandex360-Org-Id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Организация, от имени которой выполняется запрос.

_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

Участия получены.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "total": 0,
  "offset": 0,
  "limit": 0,
  "items": [
    {
      "membership_id": "example",
      "federation_id": "example",
      "member_organization_id": 0,
      "initiator_organization_id": 0,
      "status": "requested",
      "created_at": "example",
      "updated_at": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_items_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrganizationsItems](#entity-OrganizationsItems)

Список записей об участии организаций в федерациях.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "membership_id": "example",
    "federation_id": "example",
    "member_organization_id": 0,
    "initiator_organization_id": 0,
    "status": "requested",
    "created_at": "example",
    "updated_at": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Максимальное количество записей в ответе.
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Смещение от начала списка.
{.table-cell}
||
||

_total_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Общее количество записей, подходящих по параметрам запроса.
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### FederationMembership {#entity-FederationMembership}

#|
|| **Name** | **Description** ||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Дата и время создания участия.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_federation_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор федерации (UUID).

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_initiator_organization_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Идентификатор организации-инициатора приглашения.
{.table-cell}
||
||

_member_organization_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Идентификатор организации-участника.
{.table-cell}
||
||

_membership_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор участия (UUID).

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Статус участия. Возможные значения:
- `requested` — приглашение отправлено;
- `accepted` — приглашение принято, организация участвует в федерации;
- `rejected` — приглашение отклонено или отменено;
- `terminated` — участие прекращено.


_Enum:_{.json-schema-reset .json-schema-value} `requested`, `accepted`, `rejected`, `terminated`
{.table-cell}
||
||

_updated_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Дата и время последнего изменения участия.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "membership_id": "example",
  "federation_id": "example",
  "member_organization_id": 0,
  "initiator_organization_id": 0,
  "status": "requested",
  "created_at": "example",
  "updated_at": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrganizationsItems {#entity-OrganizationsItems}

Список записей об участии организаций в федерациях.

**Type**: [FederationMembership](#entity-FederationMembership)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "membership_id": "example",
    "federation_id": "example",
    "member_organization_id": 0,
    "initiator_organization_id": 0,
    "status": "requested",
    "created_at": "example",
    "updated_at": "example"
  }
]
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Некорректный запрос.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "bad_request",
  "description": "Bad request",
  "message": "Bad request",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Bad request`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `bad_request`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Bad request`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

Пользователь не авторизован.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "unauthorized",
  "description": "Unauthorized",
  "message": "Unauthorized",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Unauthorized`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `unauthorized`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Unauthorized`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

Доступ к ресурсу запрещен. У пользователя или приложения недостаточно прав.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "forbidden",
  "description": "Forbidden",
  "message": "Forbidden",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Forbidden`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `forbidden`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Forbidden`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Запрашиваемый ресурс не найден.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "not_found",
  "description": "Not found",
  "message": "Not found",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Not found`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `not_found`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Not found`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__422">

## 422 Unprocessable Entity

Возможные ошибки:

- Feature unavailable
- Invalid data

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": "feature_unavailable",
  "description": "Feature unavailable",
  "message": "Feature unavailable",
  "details": {}
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Техническое описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `Feature unavailable`
{.table-cell}
||
||

_error_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Код ошибки

_Example:_{.json-schema-reset .json-schema-example} `feature_unavailable`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Сообщение об ошибке.

_Example:_{.json-schema-reset .json-schema-example} `Feature unavailable`
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

Дополнительные детали ошибки

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>
<!-- endsource: ru/openapi/v1directoryfederationsfederation_idorganizations-get.md -->


[*Deprecated]: No longer supported, please use an alternative and newer version.