---
title: "List user invitations in an org."
method: GET
path: "/v2/org/{org-name}/users/invitations"
tags: ["Users Management"]
---

# List user invitations in an org.

`GET /v2/org/{org-name}/users/invitations`

List invitations in an org. (Org User Admin privileges required)

## Path parameters

- `org-name` string, required

## Query parameters

- `page-number` integer
- `page-size` integer
- `orderBy` 'NAME_ASC' | 'NAME_DESC'
- `q` SearchParams
  - `orderBy` SearchParamOrderBy[]
    - `field` string
    - `value` 'ASC' | 'DESC'
  - `queryFields` string[]
  - `scoredSize` integer
  - `pageSize` integer
  - `fields` string[]
  - `page` integer
  - `filters` SearchParamFilter[]
    - `field` string
    - `value` string
  - `query` string
  - `groupBy` string

## Response `200`

OK

- UserInvitationListResponse — Response for a list of user invitations.
  - `paginationInfo` PaginationInfo — object that describes the pagination information
    - `totalPages` integer — Total number of pages available
    - `index` integer — Page index of results
    - `totalResults` integer — Total number of results available
    - `nextPage` string — Serialized pointer to the next results page. Should be used for fetching next page. Can be empty
    - `size` integer — Number of results in page
  - `requestStatus` RequestStatus
    - `serverId` string
    - `statusCode` 'UNKNOWN' | 'SUCCESS' | 'UNAUTHORIZED' | 'PAYMENT_REQUIRED' | 'FORBIDDEN' | 'TIMEOUT' | 'EXISTS' | 'NOT_FOUND' | 'INTERNAL_ERROR' | 'INVALID_REQUEST' | 'INVALID_REQUEST_VERSION' | 'INVALID_REQUEST_DATA' | 'METHOD_NOT_ALLOWED' | 'CONFLICT' | 'UNPROCESSABLE_ENTITY' | 'TOO_MANY_REQUESTS' | 'INSUFFICIENT_STORAGE' | 'SERVICE_UNAVAILABLE' | 'PAYLOAD_TOO_LARGE' | 'NOT_ACCEPTABLE' | 'UNAVAILABLE_FOR_LEGAL_REASONS' | 'BAD_GATEWAY' — Describes response status reported by the server.
    - `statusDescription` string
    - `requestId` string
  - `invitations` UserInvitation[] — List of invitations.
    - `name` string — user name
    - `roles` string[] — List of roles that the user have.
    - `createdDate` string — Date on which the invitation was created. (ISO-8601 format)
    - `isProcessed` boolean — Flag indicating if the invitation has already been accepted by the user.
    - `team` string — Team to which a user was invited.
    - `id` string — Unique invitation ID
    - `org` string — Org to which a user was invited.
    - `type` 'ORGANIZATION' | 'TEAM' — Type of invitation. The invitation is either to an organization or to a team within organization.
    - `email` string — Email address of the user.

## Other responses

- `302` — Found
- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Object Exists
- `415` — Unsupported Media Type
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `451` — Unavailable For Legal Reasons
- `500` — Internal Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/brevdev/apis/ngc-api-documentation.md) · [All operations](https://skmtc.net/brevdev/apis/ngc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brevdev/ngc-api-documentation/versions/7f0aa99cc03e/schema)