Skip to content
campaiDeveloper
campai.com

Misc · Todo · Items · Comments

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

List todo comments

Lists a todo item's comments in chronological order. Accepts an offset and limit, defaulting to 0 and 20; the limit can be from 1 to 20. Returns comments and a hasMore flag.

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 todoItem.read, or must be an assignee or the reviewer of the todo.
  • When organization access is not null, non-contact actors other than the current actor are masked without user.read.
  • When organization access is not null, API key actors are masked without apiKey.read, even if they are the current actor.
  • The legacy permission contact.read also permits contact actor details to be shown.

Request

Path parameters

  • organizationIdidrequired
  • itemIdidrequired

Query parameters

  • offsetinteger

    at least 0 · default 0

  • limitinteger

    1–20 · default 20

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/comments' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • commentsobject[]
    12 properties
    • _idid
    • createdAtstring · date-timenullable
    • updatedAtstring · date-timenullable
    • removedAtstring · date-timenullable
    • createdByobjectnullable
    • updatedByobjectnullable
    • removedByobjectnullable
    • __ignoreTriggersstringnullable
    • organizationid
    • todoItemid
    • descriptionstring

      1–10000 characters

    • 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

  • hasMoreboolean
Response200
{
  "comments": [
    {
      "_id": "000000000000000000000001",
      "organization": "000000000000000000000001",
      "todoItem": "000000000000000000000001",
      "description": "string",
      "attachments": [
        {
          "resource": "string",
          "id": "string"
        }
      ]
    }
  ],
  "hasMore": true
}

Errors

Other errors

StatusErrorWhen
404Todo not foundIf the todo is not found, or the caller lacks todoItem.read and is neither an assignee nor the reviewer, the endpoint returns HTTP 404 with key libCommon.misc.todo.errors.todoNotFound.

Errors nearly every request can meet are listed under Errors.