Skip to content
campaiDeveloper
campai.com

Misc · Todo · Projects

GET/{organizationId}/misc/todo/projects/{projectId}Reads only

Get todo project

Gets one todo project in an organization, identified by organizationId and projectId. Returns the project, including its name, color, description, and todo counters.

Permissions

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

Who may call it

  • The caller must have organization access.
  • The caller needs either todoProject.read or todoItem.read.
  • Actor details may be masked without user.read. For non-contact actors, the current actor is exempt from this check.
  • API actor details may be masked without apiKey.read.

Request

Path parameters

  • organizationIdidrequired
  • projectIdidrequired
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/YOUR_PROJECT_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _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
Response200
{
  "_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"
    }
  }
}

Errors

Other errors

StatusErrorWhen
403No fixed messageReturns HTTP 403 if the caller has neither todoProject.read nor todoItem.read.
404The todo project was not foundReturns HTTP 404 with key routes.misc.todo.projects.notFound if the project is not found in the organization.

Errors nearly every request can meet are listed under Errors.