GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve user email information via the API v4 endpoint `/api/v4/user/emails`. It supports making authenticated GET requests to fetch paginated user email data. This node is useful for workflows that need to access or manage GitLab user email addresses, such as synchronizing user data or auditing email information.

Use Case Examples

  1. Fetch the authenticated user's email addresses from GitLab for user management.
  2. Retrieve paginated email data for a GitLab user to integrate with an external CRM system.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to control pagination of the user emails response.

Output

JSON

  • emails - Array of user email objects returned from the GitLab API.
  • page - Current page number of the paginated response.
  • per_page - Number of items per page in the response.
  • total_pages - Total number of pages available.
  • total_items - Total number of email items available.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access user email data.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the query parameters for pagination (page, per_page) are valid integers to avoid API errors.
  • Common error messages may include authentication failures (401 Unauthorized) or permission errors (403 Forbidden) if the API key lacks required scopes.

Links

Discussion