GitLab API

GitlabTool
Join our community

Actions905

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 to customize the member list returned. This is useful for scenarios where you need to manage or audit project members, such as fetching all users with access to a project, filtering by membership state, or searching for specific users within a project.

Use Case Examples

  1. Fetch all members of a GitLab project to display in a dashboard.
  2. Retrieve active members only to manage project access.
  3. Search for specific users by user IDs or query string within a project.
  4. Paginate through large member lists to process or export member data.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public projects or testing.
Authentication Selects the authentication method, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including project ID, query string, user IDs, seat info flag, member state, page number, and items per page.
Query Parameters Collection of query parameters to filter and paginate the member list, including query, user_ids, show_seat_info, state, page, and per_page.
Path Parameters Collection of path parameters, specifically the project ID to identify the project whose members are being retrieved.

Output

JSON

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

Dependencies

  • Requires GitLab API key credential for authentication unless skipping authentication.

Troubleshooting

  • Ensure the project ID is correctly specified; missing or incorrect ID will cause API errors.
  • Authentication errors may occur if the API key is invalid or missing when skipAuthentication is false.
  • Pagination parameters (page, per_page) should be valid integers; invalid values may cause unexpected results.
  • Filtering parameters like state must be one of the allowed values ('awaiting', 'active').
  • If user_ids is provided, it should be a comma-separated string of integers; incorrect format may cause errors.

Links

Discussion