GitLab API icon

GitLab API

Gitlab

Actions1062

Invitations → getApiV4ProjectsIdInvitations

AI-generated

Summary

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

Inputs

  • id (required) — The ID of the GitLab project whose invitations are to be retrieved.
  • page — The page number of the results to retrieve, for pagination (default is 1).
  • per_page — The number of invitation items to return per page, for pagination (default is 20).
  • query — A search string to filter member invitations.

Output shape

a list of invitation objects corresponding to the specified project ID, subject to pagination and filtering parameters

The response respects pagination parameters 'page' and 'per_page'. If 'query' is provided, only matching invitations are returned. The operation uses the GET HTTP method on the path '/api/v4/projects/{id}/invitations'. Authentication via GitLab API credentials is required unless explicitly skipped.

Links

Discussion