Return All Pages parameter may result in a timeout when retrieving extensive project lists. To prevent timeouts, use filtering parameters to reduce results or increase the timeout duration.
External DocumentationTo learn more, visit the GitLab documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Active Status | Select to get only active projects (excludes archived projects and projects that marked for deletion). |
| Archived Status | Select to get only archived projects. |
| Include Hidden Projects | Select to include hidden projects in the results. Note: This parameter is available for Premium and Ultimate users only. |
| Include Statistics | Select to include project statistics in the response. Note: This parameter is available only to users with at least the Reporter role. |
| Membership Status | Select to get only projects where the current user is a member. |
| Order By | Select the field to order results by. The following options available for administrators only: * repository_size* storage_size* packages_size* wiki_size |
| Ownership Status | Select to get only projects explicitly owned by the current user. |
| Page | The page number to get results from. The value must be greater than 0.Note: There is a maximum allowed offset, for more information refer to the GitLab Documentation. |
| Per Page | The maximum number of results to return. Note: There is a maximum allowed offset, for more information refer to the GitLab Documentation. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search | Filter the list of projects by a search criteria. The search term is matched against project names, descriptions and paths. Multiple terms can be provided, separated by a space. |
| Simple Response | Select to return only basic fields for each project, reducing response size. |
| Sort Order | Sort results in ascending or descending order. |
| Starred Status | Select to get only projects starred by the current user. |
| Topic ID | Filter projects by a specific topic ID. |
| Topic Names | A comma-separated list of topic names to filter results by. When using this parameter, only projects that match all of the specified topics will be retrieved. |
| Visibility | Select the visibility level of the projects to filter results by. |
Advanced Parameters
| Parameter | Description |
|---|---|
| ID After | Filter projects to include only those with IDs greater than the specified value. |
| ID Before | Filter projects to include only those with IDs less than the specified value. |
| Imported Status | Select to retrieve only projects imported from external systems by the current user. |
| Include Custom Attributes | Select to include pre-defined custom attributes in the response. Note: This parameter is available to administrators only. |
| Include Pending Delete | Select to include projects pending deletion. Note: This parameter is available to administrators only. |
| Issues Enabled | Select to get only projects with the issues feature enabled. |
| Last Activity After | Filter projects with activity after the specified date and time. |
| Last Activity Before | Filter projects with activity before the specified date and time. |
| Marked for Deletion Date | Filter projects marked for deletion on a specific date. Note: This parameter is available for Premium and Ultimate users only. |
| Merge Requests Enabled | Select to get only projects with the merge requests feature enabled. |
| Minimum Access Level | Filter projects where the current user has at least the specified access level. |
| Programming Language | Include only projects that use the specified programming language. |
| Repository Checksum Failed | Select to get only projects where repository checksum calculation failed. Note: This parameter is available for Premium and Ultimate users only. |
| Repository Storage | Filter projects stored on a specific repository storage. Note: This parameter is available to administrators only. |
| Search Namespaces | Select to include ancestor namespaces when matching search criteria. |
| Updated After | Filter projects last updated after the specified date and time. Note: When using this parameter, setting Order By parameter to updated_at is required. |
| Updated Before | Filter projects last updated before the specified date and time. Note: When using this parameter, setting Order By parameter to updated_at is required. |
| Wiki Checksum Failed | Select to get only projects where wiki checksum calculation failed. Note: This parameter is available for Premium and Ultimate users only. |
Example Output
[
{
"id": 4,
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
"name": "Diaspora Client",
"name_with_namespace": "Diaspora / Diaspora Client",
"path": "diaspora-client",
"path_with_namespace": "diaspora/diaspora-client",
"created_at": "2013-09-30T13:46:02Z",
"updated_at": "2013-09-30T13:46:02Z",
"default_branch": "main",
"tag_list": [
"example",
"disapora client"
],
"topics": [
"example",
"disapora client"
],
"ssh_url_to_repo": "git@gitlab.example.com:diaspora/diaspora-client.git",
"http_url_to_repo": "https://gitlab.example.com/diaspora/diaspora-client.git",
"web_url": "https://gitlab.example.com/diaspora/diaspora-client",
"readme_url": "https://gitlab.example.com/diaspora/diaspora-client/blob/main/README.md",
"avatar_url": "https://gitlab.example.com/uploads/project/avatar/4/uploads/avatar.png",
"forks_count": 0,
"star_count": 0,
"last_activity_at": "2022-06-24T17:11:26.841Z",
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
"kind": "group",
"full_path": "diaspora",
"parent_id": null,
"avatar_url": "https://gitlab.example.com/uploads/project/avatar/6/uploads/avatar.png",
"web_url": "https://gitlab.example.com/diaspora"
},
"container_registry_image_prefix": "registry.gitlab.example.com/diaspora/diaspora-client",
"_links": {
"self": "https://gitlab.example.com/api/v4/projects/4",
"issues": "https://gitlab.example.com/api/v4/projects/4/issues",
"merge_requests": "https://gitlab.example.com/api/v4/projects/4/merge_requests",
"repo_branches": "https://gitlab.example.com/api/v4/projects/4/repository/branches",
"labels": "https://gitlab.example.com/api/v4/projects/4/labels",
"events": "https://gitlab.example.com/api/v4/projects/4/events",
"members": "https://gitlab.example.com/api/v4/projects/4/members",
"cluster_agents": "https://gitlab.example.com/api/v4/projects/4/cluster_agents"
},
"packages_enabled": true,
"empty_repo": false,
"archived": false,
"visibility": "public",
"resolve_outdated_diff_discussions": false,
"container_expiration_policy": {
"cadence": "1month",
"enabled": true,
"keep_n": 1,
"older_than": "14d",
"name_regex": "",
"name_regex_keep": ".*-main",
"next_run_at": "2022-06-25T17:11:26.865Z"
},
"issues_enabled": true,
"merge_requests_enabled": true,
"wiki_enabled": true,
"jobs_enabled": true,
"snippets_enabled": true,
"container_registry_enabled": true,
"service_desk_enabled": true,
"can_create_merge_request_in": true,
"issues_access_level": "enabled",
"repository_access_level": "enabled",
"merge_requests_access_level": "enabled",
"forking_access_level": "enabled",
"wiki_access_level": "enabled",
"builds_access_level": "enabled",
"snippets_access_level": "enabled",
"pages_access_level": "enabled",
"analytics_access_level": "enabled",
"container_registry_access_level": "enabled",
"security_and_compliance_access_level": "private",
"emails_disabled": null,
"emails_enabled": null,
"shared_runners_enabled": true,
"group_runners_enabled": true,
"lfs_enabled": true,
"creator_id": 1,
"import_url": null,
"import_type": null,
"import_status": "none",
"import_error": null,
"open_issues_count": 0,
"ci_default_git_depth": 20,
"ci_forward_deployment_enabled": true,
"ci_forward_deployment_rollback_allowed": true,
"ci_allow_fork_pipelines_to_run_in_parent_project": true,
"ci_id_token_sub_claim_components": [
"project_path",
"ref_type",
"ref"
],
"ci_job_token_scope_enabled": false,
"ci_separated_caches": true,
"ci_restrict_pipeline_cancellation_role": "developer",
"ci_pipeline_variables_minimum_override_role": "maintainer",
"ci_push_repository_for_job_token_allowed": false,
"public_jobs": true,
"build_timeout": 3600,
"auto_cancel_pending_pipelines": "enabled",
"ci_config_path": "",
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
"allow_merge_on_skipped_pipeline": null,
"allow_pipeline_trigger_approve_deployment": false,
"restrict_user_defined_variables": false,
"request_access_enabled": true,
"only_allow_merge_if_all_discussions_are_resolved": false,
"remove_source_branch_after_merge": true,
"printing_merge_request_link_enabled": true,
"merge_method": "merge",
"squash_option": "default_off",
"enforce_auth_checks_on_uploads": true,
"suggestion_commit_message": null,
"merge_commit_template": null,
"squash_commit_template": null,
"issue_branch_template": "gitlab/%{id}-%{title}",
"auto_devops_enabled": false,
"auto_devops_deploy_strategy": "continuous",
"autoclose_referenced_issues": true,
"keep_latest_artifact": true,
"runner_token_expiration_interval": null,
"external_authorization_classification_label": "",
"requirements_enabled": false,
"requirements_access_level": "enabled",
"security_and_compliance_enabled": false,
"secret_push_protection_enabled": false,
"compliance_frameworks": [],
"warn_about_potentially_unwanted_characters": true,
"permissions": {
"project_access": null,
"group_access": null
}
}
]
Workflow Library Example
List All Projects with Gitlab and Send Results Via Email