GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves invitations for a specific group from the GitLab API (version 4). It is useful for managing group invitations, such as listing pending invitations to a group in GitLab. For example, an administrator can use this node to fetch all invitations sent to users for a particular group, optionally filtering by page, number of items per page, or a search query.

Use Case Examples

  1. Fetch all invitations for a GitLab group with ID '123'.
  2. Retrieve the second page of invitations with 50 invitations per page for group '123'.
  3. Search invitations in group '123' with a query string to filter members.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send requests to, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the parameters for the API call including the group ID (path parameter), pagination (page and per_page), and a query string to search for members.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path template for fetching group invitations, with {id} as the group ID placeholder.
Query Parameters Optional query parameters for pagination and filtering: page (current page number), per_page (items per page), and query (search string).
Path Parameters Path parameters including the group ID to specify which group's invitations to retrieve.

Output

JSON

  • invitations - List of invitations for the specified GitLab group, including details about each invitation such as invitee information and invitation status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID path parameter is correctly set and corresponds to an existing group in GitLab.
  • Verify that the API key credential has sufficient permissions to access group invitations.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause errors or unexpected results.
  • If the query parameter is used, ensure it is a valid string to avoid filtering issues.

Links

Discussion