Get all accessible projects

Retrieves all projects the current user has access to, including managed projects, membership projects, and shared projects (for admins).

get/projects

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/projects
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Response

Projects retrieved successfully

Example response

{
  "items": [
    {
      "id": "1357158568008091264",
      "ownerProjectManagerId": "1357158568008091265",
      "backgroundImageId": "1357158568008091266",
      "name": "Development Project",
      "description": "A project for developing new features...",
      "backgroundType": "gradient",
      "backgroundGradient": "ocean-dive",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "isFavorite": true
    }
  ],
  "included": {
    "users": [
      {
        "id": "1357158568008091264",
        "email": "john.doe@example.com",
        "role": "admin",
        "name": "John Doe",
        "username": "john_doe",
        "avatar": {
          "url": "https://storage.example.com/user-avatars/1357158568008091264/original.jpg",
          "thumbnailUrls": {
            "cover180": "https://storage.example.com/user-avatars/1357158568008091264/cover-180.jpg"
          }
        },
        "gravatarUrl": "https://www.gravatar.com/avatar/abc123",
        "phone": "+1234567890",
        "organization": "Acme Corporation",
        "language": "en-US",
        "apiKeyPrefix": "D89VszVs",
        "subscribeToCardWhenCommenting": true,
        "enableFavoritesByDefault": true,
        "defaultEditorMode": "wysiwyg",
        "defaultHomeView": "groupedProjects",
        "defaultProjectsOrder": "byDefault",
        "lockedFieldNames": [
          "email",
          "password",
          "name"
        ],
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "projectManagers": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "userId": "1357158568008091266",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "backgroundImages": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "size": "1024576",
        "url": "https://storage.example.com/background-images/1357158568008091264/original.jpg",
        "thumbnailUrls": {
          "outside360": "https://storage.example.com/background-images/1357158568008091264/outside-360.jpg"
        },
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "baseCustomFieldGroups": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "name": "Base Properties",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "boards": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "position": 65536,
        "name": "Development Board",
        "defaultView": "kanban",
        "defaultCardType": "project",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "boardMemberships": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "boardId": "1357158568008091266",
        "userId": "1357158568008091267",
        "role": "editor",
        "canComment": true,
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "customFields": [
      {
        "id": "1357158568008091264",
        "baseCustomFieldGroupId": "1357158568008091265",
        "customFieldGroupId": "1357158568008091266",
        "position": 65536,
        "name": "Priority",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "notificationServices": [
      {
        "id": "1357158568008091264",
        "userId": "1357158568008091265",
        "boardId": "1357158568008091266",
        "url": "https://service.example.com/planka",
        "format": "text",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.