GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 email data for the authenticated user. This is useful for workflows that need to access or manage user email addresses stored in GitLab, such as synchronizing user contact information or verifying user emails.

Use Case Examples

  1. Fetch the authenticated user's email addresses from GitLab to update a CRM system.
  2. Retrieve paginated user email data for auditing or reporting purposes.

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 requests are sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET.
Parameter Schema Defines the query parameters for pagination, including page number and items per page, used in the GET request to fetch user emails.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path for fetching user emails, fixed to `/api/v4/user/emails`.
Query Parameters Collection of query parameters to customize the request, including 'page' and 'per_page' for pagination.

Output

JSON

  • response - The JSON response containing the list of user email objects retrieved from the GitLab API.

Dependencies

  • Requires GitLab API key authentication credentials to access the GitLab API.

Troubleshooting

  • If authentication fails, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • If the API request returns an error, check the baseUrl to ensure it points to a valid GitLab instance.
  • Pagination parameters 'page' and 'per_page' must be valid integers; invalid values may cause request failures.

Links

Discussion