GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves invitations for a specific project from the GitLab API (v4). It is useful for managing project invitations, such as listing all users invited to collaborate on a project. Practical examples include automating the monitoring of project invitations or integrating invitation data into other workflows.

Use Case Examples

  1. Retrieve all invitations for a project with ID 12345 to monitor pending invites.
  2. Search for invitations matching a query string to find specific invited members.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the parameters for the API request including path and query parameters such as project ID, page number, items per page, and search query.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path The API endpoint path with a placeholder for the project ID.
Query Parameters Optional query parameters to paginate results and filter invitations by a search query.
Path Parameters Path parameters including the project ID to specify which project's invitations to retrieve.

Output

JSON

  • invitations - List of invitations retrieved from the GitLab project.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID is valid and accessible with the provided authentication.
  • Check that the base URL is correct for the GitLab instance being accessed.
  • Verify that the authentication credentials are correctly configured and have sufficient permissions.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion