Get a Project ID

To get a project ID

1. Get a list of available projects.

   curl -X GET \ 'https://example.youtrack.cloud/api/admin/projects?fields=id,name,shortName' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer <YouTrack_token>' \ -H 'Content-Type: application/json'

   In the fields request parameter, you instruct the server to return the id, name, and shortName attributes of each project.

   For such request, you get response from the server with the following body:

   [ { "shortName": "GRP", "name": "GRA Project", "id": "0-7", "$type": "Project" }, { "shortName": "RAP", "name": "Rest Api Project", "id": "0-2", "$type": "Project" }, { "shortName": "RP", "name": "Rest Project", "id": "0-6", "$type": "Project" }, { "shortName": "SP", "name": "Sample Project", "id": "0-0", "$type": "Project" }, { "shortName": "SNBX", "name": "Sandbox", "id": "0-3", "$type": "Project" } ]

2. Optional. Filter the list of projects by the project name or shortName.

   Sample request with the filter by a project's name:

   curl -X GET \ 'https://example.youtrack.cloud/api/admin/projects?fields=id,name,shortName&query=Sample+Project' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer <YouTrack_token>' \ -H 'Content-Type: application/json'

   Sample request with the filter by a project's shortName:

   curl -X GET \ 'https://example.youtrack.cloud/api/admin/projects?fields=id,name,shortName&query=sp' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer <YouTrack_token>' \ -H 'Content-Type: application/json'

   To the sample request with the query parameter, the response body contains data only for the matching project:

   [ { "shortName": "SP", "name": "Sample Project", "id": "0-0", "$type": "Project" } ]

3. In the response from the server, locate the id of the target project.

   In this example, the project entity ID is 0-0.