GitLab API

GitlabTool

Actions1095

Invitations → getApiV4ProjectsIdInvitations

AI-generated

Summary

Retrieve a paginated list of invitations for a specified GitLab project by project ID, optionally filtering by a query string.

Inputs

  • Id (required) — The project ID to identify the GitLab project whose invitations are being retrieved.
  • Page — The page number to retrieve, for pagination (default is 1).
  • Per_page — The number of invitation items to return per page (default is 20).
  • Query — A query string to search or filter invitations by member name or related criteria.
  • Skip Authentication — Whether to skip authentication for the request (default is false, meaning authentication is used).
  • baseUrl — The base URL of the GitLab instance (defaults to https://gitlab.com).

Output shape

a paginated JSON list of invitation objects corresponding to the specified project ID, each detailing invitation information as provided by the GitLab API

Supports pagination through 'page' and 'per_page' query parameters. If provided, 'query' filters invitations. Authentication is used unless explicitly skipped.

Examples

Example 1: Retrieve first page of invitations for project with ID '123'

Set 'Id' to '123', use default 'Page' and 'Per_page' values, and no 'Query'. Result will be a list of invitations for project 123.

Links

Discussion