Skip to content
forgit api docs

Search a project

GET
/api/v4/projects/{id}/(-/)search

Searches for content in a specified project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
One of:
string

The ID or URL-encoded path of the project

Query Parameters

Section titled “Query Parameters”
search
required
string
nullable

The expression it should be searched for

scope
required
string
>= 1 characters
Allowed values: issues work_items merge_requests milestones notes wiki_blobs commits blobs users

The scope of the search

ref
string
nullable

The name of a repository branch or tag. If not given, the default branch is used

state
string
nullable
Allowed values: all opened closed merged

Filter results by state

confidential
boolean
nullable

Filter results by confidentiality

type
Array<string>
nullable

Filter work items by type. Only applies to work_items scope. Available types: issue, task, epic, incident, test_case, requirement, objective, key_result, ticket.

fields
Array<string>
nullable

Array of fields you wish to search. Available with advanced search.

num_context_lines
integer
nullable <= 20

Number of context lines around each match. Available with advanced and exact code search. Introduced in GitLab 18.11.

regex
boolean
nullable

Performs a regex code search. Available with exact code search. Introduced in GitLab 18.9

page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20

Responses

Section titled “Responses”

200

Section titled “200”

OK

400

Section titled “400”

Bad Request

404

Section titled “404”

Not Found