Skip to content
campaiDeveloper
campai.com

Misc · Todo · Items

GET/{organizationId}/misc/todo/items/{itemId}Reads only

Get todo item

Gets one todo item by organization ID and item ID. You can optionally provide both contextType and contextId to restrict the match. The response includes the item and the current caller’s assignment index; actor details may be masked based on permissions.

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 with todoItem.read.
  • Non-contact actors other than the current actor are masked without user.read.
  • API actors are masked without apiKey.read. A non-current API actor also needs user.read to remain visible.
  • The legacy permission contact.read also allows contact actor details to be visible.
  • When contextType and contextId are supplied, the item must match both to be returned.

Request

Path parameters

  • organizationIdidrequired
  • itemIdidrequired

Query parameters

  • contextTypestring
    team event resource conversation
  • contextIdid
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_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
  • parentItemidnullable
  • childrenCountinteger

    0–100

  • childrenCompletedCountinteger

    0–100

  • commentsCountinteger

    at least 0

  • topicobject
    4 properties
    • _idid
    • namestring

      1–80 characters

    • identifierstring

      1–4 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
  • typeobject
    3 properties
    • _idid
    • namestring

      1–80 characters

    • emojistring

      at most 16 characters

  • statusobject
    4 properties
    • _idid
    • labelstring

      1–80 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
    • rolestring
      regular review completed
  • contextobjectnullable
    Variant 1: 3 properties
    • typestring
    • teamIdidnullable
    • namestring

      1–80 characters

    Variant 2: 6 properties
    • typestring
    • eventIdidnullable
    • namestring

      1–80 characters

    • seriesIdstringnullable

      exactly 10 characters

    • fromstring · date-time
    • tostring · date-time
    Variant 3: 3 properties
    • typestring
    • resourceIdidnullable
    • namestring

      1–200 characters

    Variant 4: 3 properties
    • typestring
    • conversationIdidnullable
    • namestring

      1–200 characters

  • projectobjectnullable
    3 properties
    • _idid
    • 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
  • sequenceNumberinteger
  • titlestring

    1–140 characters

  • descriptionstring

    1–10000 characters

  • customFieldsobject of one of 7 types | object of one of 7 types | object (recursive)[] | (one of 7 types)[][]

    The answers of a form, by the ID of each field. A repeating group holds a list of its entries under its own ID.

  • attachmentsobject[]

    at most 10 items

    5 properties
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

    • idstring

      exactly 6 characters

  • attachmentCountinteger

    0–10

  • assigneesobject[]

    at most 100 items

    4 properties
    • idstring

      exactly 10 characters

    • actorobject
    • completedAtstring · date-timenullable
    • timeSpentMinutesintegernullable

      at least 0

  • tagsstring[]

    at most 20 items · each 1–40 characters

  • dueDatestring · date-timenullable
  • reviewerobjectnullable
    4 properties
    • namestring
    • typestring
    • userIdstring
    • imageobjectnullable
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

  • reviewsobject[]
    17 properties
    • _idid
    • createdAtstring · date-timenullable
    • updatedAtstring · date-timenullable
    • removedAtstring · date-timenullable
    • createdByobjectnullable
    • updatedByobjectnullable
    • removedByobjectnullable
    • __ignoreTriggersstringnullable
    • roundinteger
    • reviewerobject
      4 properties
      • namestring
      • typestring
      • userIdstring
      • imageobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

    • requestedAtstring · date-time
    • requestedByobject
    • workCompletedAtstring · date-time
    • decisionstring
      pending accepted rejected withdrawn
    • decidedAtstring · date-timenullable
    • decidedByobjectnullable
    • notestring

      at most 4000 characters

  • statusBeforeReviewobjectnullable
    4 properties
    • _idid
    • labelstring

      1–80 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
    • rolestring
      regular review completed
  • workCompletedAtstring · date-timenullable
  • completedAtstring · date-timenullable
  • statusBeforeCompletionobjectnullable
    4 properties
    • _idid
    • labelstring

      1–80 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
    • rolestring
      regular review completed
  • currentAssignmentIndexinteger

    at least -1

More about the fields

  • assignees[].actor.user.image: For a visible contact’s linked user other than the current actor, the user’s image is null and name is replaced when the caller lacks user.read.
Response200
{
  "_id": "000000000000000000000001",
  "organization": "000000000000000000000001",
  "parentItem": "000000000000000000000001",
  "childrenCount": 0,
  "childrenCompletedCount": 0,
  "commentsCount": 0,
  "topic": {
    "_id": "000000000000000000000001",
    "name": "string",
    "identifier": "string",
    "color": "slate"
  },
  "type": {
    "_id": "000000000000000000000001",
    "name": "string",
    "emoji": "string"
  },
  "status": {
    "_id": "000000000000000000000001",
    "label": "string",
    "color": "slate",
    "role": "regular"
  },
  "context": {
    "type": "team",
    "teamId": "000000000000000000000001",
    "name": "string"
  },
  "project": {
    "_id": "000000000000000000000001",
    "name": "string",
    "color": "slate"
  },
  "sequenceNumber": 1,
  "title": "string",
  "description": "string",
  "customFields": {
    "key": "2026-10-22T12:00:00Z"
  },
  "attachments": [
    {
      "resource": "string",
      "id": "string"
    }
  ],
  "attachmentCount": 0,
  "assignees": [
    {
      "id": "string",
      "actor": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "completedAt": "2026-06-15T22:30:00Z",
      "timeSpentMinutes": 0
    }
  ],
  "tags": [
    "string"
  ],
  "dueDate": "2026-06-15T22:30:00Z",
  "reviewer": {
    "name": "string",
    "type": "user",
    "userId": "string",
    "image": {
      "resource": "string"
    }
  },
  "reviews": [
    {
      "_id": "000000000000000000000001",
      "round": 1,
      "reviewer": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "requestedAt": "2026-06-15T22:30:00Z",
      "requestedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "workCompletedAt": "2026-06-15T22:30:00Z",
      "decision": "pending",
      "decidedAt": "2026-06-15T22:30:00Z",
      "decidedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "note": "string"
    }
  ],
  "statusBeforeReview": {
    "_id": "000000000000000000000001",
    "label": "string",
    "color": "slate",
    "role": "regular"
  },
  "workCompletedAt": "2026-06-15T22:30:00Z",
  "completedAt": "2026-06-15T22:30:00Z",
  "statusBeforeCompletion": {
    "_id": "000000000000000000000001",
    "label": "string",
    "color": "slate",
    "role": "regular"
  },
  "currentAssignmentIndex": -1
}

Errors

Other errors

StatusErrorWhen
404Todo not foundIf no accessible item matches the request, the endpoint returns HTTP 404 with key libCommon.misc.todo.errors.todoNotFound.

Errors nearly every request can meet are listed under Errors.