List projects

GET/v1/projects

Signed-in sessionLaunch key product.projectsOperation projects_list

People plan work as projects with tasks, sprints, a board, a backlog, a timeline and a dashboard, and write shared documents in one editor with history and media.

Query parameters

statusstring
textstring
cursorstring
expectedAuthorizationVersionstring
limitnumber

Returns

itemsobject[]Required
cursornull | stringRequired
partialbooleanRequired
source"canonical"Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

GET/v1/projects

curl "$SPECIFY_API_ORIGIN/v1/projects" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "items": [
      {
        "publicId": "<publicId>",
        "schemaVersion": 1,
        "createdAt": 1,
        "createdByActorId": "<createdByActorId>",
        "updatedAt": 1,
        "updatedByActorId": "<updatedByActorId>",
        "version": 1,
        "key": "<key>",
        "name": "<name>",
        "ownerActorId": "<ownerActorId>",
        "visibility": "private",
        "status": "active",
        "goal": "<goal>",
        "searchGeneration": 1,
        "permissionGeneration": 1,
        "legacyDefaultStatusByColumn": {
          "capture": "<capture>",
          "ready": "<ready>",
          "focus": "<focus>",
          "waiting": "<waiting>",
          "review": "<review>",
          "done": "<done>"
        }
      }
    ],
    "cursor": "<cursor>",
    "partial": true,
    "source": "canonical"
  }
}

List projects

Headers

Query parameters

Returns

Errors