GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves all members of a specified GitLab project using the GitLab API v4 endpoint `/api/v4/projects/{id}/members/all`. It supports filtering and pagination options, allowing users to search for members by query string, filter by user IDs, member state, and control the number of results per page. This operation is useful for managing project memberships, auditing access, or integrating member data into workflows.

Use Case Examples

  1. Fetch all members of a GitLab project to synchronize with an internal user management system.
  2. Retrieve active members of a project to generate access reports.
  3. Search for specific users within a project's members by user IDs or query string.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used for the request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent, default is https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Parameter Schema Defines the parameters for the API request including project ID, query string, user IDs, seat info display, member state, pagination page, and items per page.
Query Parameters Collection of optional query parameters to filter and paginate the members list, including query, user_ids, show_seat_info, state, page, and per_page.
Path Parameters Collection of path parameters required for the API request, specifically the project ID.

Output

JSON

  • id - The unique identifier of the member.
  • username - The username of the member.
  • name - The full name of the member.
  • state - The state of the member (e.g., active, awaiting).
  • access_level - The access level of the member in the project.
  • expires_at - The expiration date of the member's access, if any.
  • avatar_url - URL to the member's avatar image.
  • web_url - URL to the member's profile page.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key credential has sufficient permissions to access project members.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters are used, ensure page and per_page values are within valid ranges to avoid empty results.
  • If filtering by user_ids or state, confirm the values are valid and correspond to existing users or states.

Links

Discussion