GitLab API icon

GitLab API

Gitlab

Actions1062

Invitations → getApiV4GroupsIdInvitations

AI-generated

Summary

Retrieve invitations for a specific GitLab group by specifying the group ID and optional query parameters for pagination and search filtering.

Inputs

  • Id (required) — The unique identifier of the GitLab group whose invitations are being retrieved.
  • Page — The current page number to fetch in paginated results; defaults to 1.
  • Per_page — The number of invitation records to return per page; defaults to 20.
  • Query — A string to filter invitations by matching members' attributes.

Output shape

a JSON array of invitation objects belonging to the specified group.

Supports pagination through 'page' and 'per_page' query parameters. The data returned corresponds to the GitLab API's response to GET /api/v4/groups/{id}/invitations. If no invitations exist or parameters are invalid, the output will be an empty array or error respectively.

Examples

Example 1: List the first 20 invitations for group with ID '12345'.

Set 'Id' path parameter to '12345'. Leave 'Page' and 'Per_page' empty or set to 1 and 20 respectively. Invoke the operation to return the first page of invitation records.

Links

Discussion