ROroarkhq
Project

List projects available to this credential

Changed on

Returns every project the calling credential may act on, with the permissions it holds in each. A project-scoped API key returns the single project it is bound to. A user-scoped credential returns the projects in its organization where the holder is an active member. Use the returned id in the X-Roark-Project-Id header.

get/v1/projects

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/projects
  • Auth
    HTTP bearer

Response

Projects available to this credential

Example response

{
  "data": {
    "projects": [
      {
        "id": "1a2b3c4d-5e6f-4701-8293-a4b5c6d7e8f9",
        "name": "Support Line",
        "slug": "support-line",
        "organization": {
          "id": "9f8e7d6c-5b4a-4312-9081-7f6e5d4c3b2a",
          "name": "Example Inc"
        },
        "grantedPermissions": [
          "call:read",
          "metric:read"
        ]
      }
    ]
  }
}

Changes