Skip to content
campaiDeveloper
campai.com

Misc · Todo · Projects

GET/{organizationId}/misc/todo/projectsReads only

List todo projects

Lists todo projects with their names, colors and descriptions

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • todoProject.read or todoItem.read
Also checked, depending on the request and the records it touches
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired

Query parameters

  • sortobject of string
    asc desc
    Keys: one of 44 values
    _id createdAt updatedAt removedAt createdBy.name createdBy.type createdBy.userId createdBy.image.resource createdBy.image.fileName createdBy.image.contentType createdBy.image.fileSizeBytes createdBy.key updatedBy.name updatedBy.type updatedBy.userId updatedBy.image.resource updatedBy.image.fileName updatedBy.image.contentType updatedBy.image.fileSizeBytes updatedBy.key removedBy.name removedBy.type removedBy.userId removedBy.image.resource removedBy.image.fileName removedBy.image.contentType removedBy.image.fileSizeBytes removedBy.key __ignoreTriggers organization name color description openCount closedCount archivedAt archivedBy.name archivedBy.type archivedBy.userId archivedBy.image.resource archivedBy.image.fileName archivedBy.image.contentType archivedBy.image.fileSizeBytes archivedBy.key
  • limitinteger

    0–20 · default 20

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

  • includeArchivedboolean

    default false

  • archivedboolean
  • userFilterstringnullable
  • searchTermstring

    1–100 characters

  • projectIdsid[]

    at most 50 items

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • projectsobject[]
    16 properties
    • _idid
    • createdAtstring · date-timenullable
    • updatedAtstring · date-timenullable
    • removedAtstring · date-timenullable
    • createdByobjectnullable
    • updatedByobjectnullable
    • removedByobjectnullable
    • __ignoreTriggersstringnullable
    • organizationid
    • namestring

      1–64 characters

    • colorstring
      22 values
      slate gray zinc neutral stone red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose
    • descriptionstring

      at most 400 characters

    • openCountinteger

      at least 0

    • closedCountinteger

      at least 0

    • archivedAtstring · date-timenullable
    • archivedByobjectnullable
  • countinteger

    at least 0

Response200
{
  "projects": [
    {
      "_id": "000000000000000000000001",
      "organization": "000000000000000000000001",
      "name": "string",
      "color": "slate",
      "description": "string",
      "openCount": 0,
      "closedCount": 0,
      "archivedAt": "2026-06-15T22:30:00Z",
      "archivedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      }
    }
  ],
  "count": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.