/gitlab/projects/search

POST /api/gitlab/projects/search

Price: 1 credit

Search public GitLab projects by keyword with optional sort field and order

How to use it

Search public GitLab projects by keyword (matched against project name and path). Returns id, name, description, default branch, visibility, star/fork counts, topics, license, namespace, timestamps, repository URLs, and avatar. Sort by star_count (default), created_at, last_activity_at, or name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• search string required — Search keyword to match against project name and path (minLength: 1)
• count integer required — Number of projects to return (min: 1)
• order_by string — Sort projects by this field (default: "star_count"; one of: "star_count", "created_at", "last_activity_at", "name")
• sort string — Sort order (default: "desc"; one of: "desc", "asc")

Response

• @type string (default: "GitlabProject")
• id integer required
• alias string required
• name string required
• name_with_namespace string (default: "")
• path string (default: "")
• description string nullable
• default_branch string (default: "")
• visibility string (default: "")
• star_count integer (default: 0)
• fork_count integer (default: 0)
• open_issues_count integer (default: 0)
• topics array (default: [])
• last_activity_at string (default: "")
• created_at string (default: "")
• web_url string (default: "")
• http_url_to_repo string (default: "")
• ssh_url_to_repo string (default: "")
• readme_url string nullable
• image string nullable
• license_url string nullable
• namespace object nullable
  • @type string (default: "GitlabNamespace")
  • id integer required
  • name string (default: "")
  • path string (default: "")
  • kind string (default: "")
  • full_path string (default: "")
  • parent_id integer nullable
  • image string nullable
  • web_url string (default: "")
• license object nullable
  • @type string (default: "GitlabLicense")
  • key string (default: "")
  • name string (default: "")
  • nickname string nullable
  • html_url string nullable
• statistics object nullable
  • @type string (default: "GitlabStatistics")
  • commit_count integer (default: 0)
  • storage_size integer (default: 0)
  • repository_size integer (default: 0)
  • job_artifacts_size integer (default: 0)
  • lfs_objects_size integer (default: 0)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.