Sign in
v1 projects

Get projects

Get projects accessible to the caller.

This endpoint:
- **No user_id param** (or user_id == root user): root user → returns **all** projects across the org
- **user_id param** (sub-user): returns only that sub-user's projects
- Includes project metadata (name, description, creation date)

**Authentication**: Requires valid API key or JWT token
get/v1/projects

Query parameters

user_idstring nullable

Response

Successful Response

total_countinteger required

Total number of projects

user_idstring nullable

User ID (set when filtering by user)

org_idstring nullable

Organization ID (set when returning org-wide projects)

Example response

{
  "projects": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "description": "A project for organizing research notes",
      "name": "My Research Project",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2023-01-15T00:00:00Z",
      "user_email": "john@example.com",
      "user_id": "456e7890-e89b-12d3-a456-426614174001",
      "user_name": "John Doe"
    }
  ],
  "total_count": 1,
  "user_id": "456e7890-e89b-12d3-a456-426614174001"
}

Changes

Changed in 3 of the 29 revisions of this API.25

  • 0f1ebe15057423See the full diff
    • ▲

      the response property user_id became optional for the status 200

      response-property-became-optional

    • ▲

      response property user_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the new optional query request parameter user_id

      new-optional-request-parameter

    • ○

      added the non-success response with the status 422

      response-non-success-status-added

    • ○

      added the optional property org_id to the response with the 200 status

      response-optional-property-added

  • ad860831e5241See the full diff
    • ○

      added the optional property projects/items/project_type to the response with the 200 status

      response-optional-property-added

  • 1660d0b2cbd91See the full diff
    • ○

      endpoint added

      endpoint-added