Get Project and Organization Data

Get the ID of the project whose data you want to retrieve. For instructions, see Get a Project ID. This sample uses the project ID 0-6.

Get data for a specific project using its database entity ID.

          curl -X GET \
          'https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id)' \
          -H 'Accept: application/json' \
          -H 'Authorization: Bearer <YouTrack_token>'
        

In response, the server returns data for the requested project:

          {
            "description": "A project created using REST API",
            "leader": {
              "login": "root",
              "name": "John Smith",
              "id": "1-1",
              "$type": "User"
            },
            "shortName": "RP",
            "createdBy": {
              "login": "john.doe",
              "name": "John Doe",
              "id": "1-2",
              "$type": "User"
            },
            "name": "Rest Project",
            "id": "0-6",
            "$type": "Project"
          }
        

Get a list of organizations and the projects that belong to them.

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

In response, the server returns organization data with the nested project data requested in projects(id,name,shortName):

          [
            {
              "id": "120-1",
              "key": "92da6595-c398-481d-9071-c821ff49772b",
              "name": "JetBrains",
              "projects": [
                {
                  "id": "0-0",
                  "name": "Sample Project",
                  "shortName": "SP",
                  "$type": "Project"
                }
              ],
              "$type": "Organization"
            },
            {
              "id": "120-2",
              "key": "V2x9UNmH_L-5PHQ71qd0S",
              "name": "Acme Corp",
              "projects": [],
              "$type": "Organization"
            }
          ]
        

Optional. Get data for a specific organization.

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

In response, the server returns data for the requested organization:

          {
            "id": "120-1",
            "key": "92da6595-c398-481d-9071-c821ff49772b",
            "name": "JetBrains",
            "projects": [
              {
                "id": "0-0",
                "name": "Sample Project",
                "shortName": "SP",
                "$type": "Project"
              }
            ],
            "$type": "Organization"
          }
        

Developer Portal for YouTrack and Hub Help

Summary

Step-by-Step

To retrieve project and organization data