Skip to content
campaiDeveloper
campai.com

Misc · Todo · Items

POST/{organizationId}/misc/todo/items/listReads only

List todo items

Lists root todos or the direct children of one todo

Permissions

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

Permission checks in detail
Required permissions
  • 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

Body

Content-Type: application/json

  • parentItemIdidnullable
  • topicIdsid[]

    at most 50 items

  • statusIdsid[]

    at most 100 items

  • contexts(object)[]

    at most 100 items

    Variant 1: 2 properties
    • typestringrequired
    • teamIdidrequired
    Variant 2: 2 properties
    • typestringrequired
    • eventIdidrequired
    Variant 3: 2 properties
    • typestringrequired
    • resourceIdidrequired
    Variant 4: 2 properties
    • typestringrequired
    • conversationIdidrequired
  • contextTypesstring[]

    at most 4 items

    team event resource conversation
  • withoutContextboolean

    default false

  • searchTermstring

    2–100 characters

  • userFilterstringnullable

    A stringified json object representing a property filter

  • searchAllLevelsboolean

    default false

  • groupByStatusboolean

    default false

  • offsetinteger

    at least 0 · default 0

  • cursorobjectnullable
  • limitinteger

    1–20 · default 20

  • returnCountboolean

    default false

  • sortobject

    default {"column":"createdAt","order":"desc"}

    2 properties
    • columnstringrequired
      createdAt title topic.name type.name status.label dueDate
    • orderstringrequired
      asc desc
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/list' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • itemsobject[]
    31 properties
    • _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.

    • 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
  • countinteger

    at least 0

  • nextCursorobjectnullable
  • statusGroupsobject[]
    4 properties
    • statusIdid
    • itemsobject[]
      31 properties
      • _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.

      • 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
    • countinteger

      at least 0

    • nextCursorobjectnullable
Response200
{
  "items": [
    {
      "_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"
      },
      "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"
    }
  ],
  "count": 0,
  "nextCursor": {
    "column": "title",
    "value": "string",
    "itemId": "000000000000000000000001"
  },
  "statusGroups": [
    {
      "statusId": "000000000000000000000001",
      "items": [
        {
          "_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"
          },
          "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"
        }
      ],
      "count": 0,
      "nextCursor": {
        "column": "title",
        "value": "string",
        "itemId": "000000000000000000000001"
      }
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.