GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves invitations for a specific project from the GitLab API (version 4). 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 a given project ID.
  2. Search for invitations matching a query string within a project.
  3. Paginate through invitations by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication for the request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET.
Query Parameters Optional query parameters to control pagination and filtering of invitations.
Path Parameters Path parameters required for the API endpoint.

Output

JSON

  • invitations - List of invitations retrieved from the project.
  • pagination
    • page - Current page number of the results.
    • per_page - Number of items per page in the results.
    • total - Total number of invitations available.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is valid and accessible with the provided authentication.
  • Check that the base URL is correct and reachable.
  • Verify that the authentication token has sufficient permissions to read project invitations.
  • Common error messages include 401 Unauthorized (invalid or missing token), 404 Not Found (invalid project ID), and 400 Bad Request (invalid query parameters). Resolving these involves correcting credentials, project ID, or query parameters.

Links

Discussion