Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

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

List todo topics

Lists todo topics and their available workflows

Permissions

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

Permission checks in detail
Required permissions
  • todoTopic.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 107 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 identifier lastSequenceNumber color description revision openCount closedCount archivedAt archivedBy.name archivedBy.type archivedBy.userId archivedBy.image.resource archivedBy.image.fileName archivedBy.image.contentType archivedBy.image.fileSizeBytes archivedBy.key customFields.groups customFields.pages customFields.submitCaption customFields.appearance.accentColor customFields.appearance.accentTextColor customFields.appearance.box.border.width customFields.appearance.box.border.color customFields.appearance.box.border.radius customFields.appearance.box.background.color customFields.appearance.box.font.color customFields.appearance.box.font.size customFields.appearance.box.font.weight customFields.appearance.box.shadows customFields.appearance.box.padding.left customFields.appearance.box.padding.right customFields.appearance.box.padding.top customFields.appearance.box.padding.bottom customFields.appearance.box.margin.left customFields.appearance.box.margin.right customFields.appearance.box.margin.top customFields.appearance.box.margin.bottom customFields.appearance.groupBox.border.width customFields.appearance.groupBox.border.color customFields.appearance.groupBox.border.radius customFields.appearance.groupBox.background.color customFields.appearance.groupBox.font.color customFields.appearance.groupBox.font.size customFields.appearance.groupBox.font.weight customFields.appearance.groupBox.shadows customFields.appearance.groupBox.padding.left customFields.appearance.groupBox.padding.right customFields.appearance.groupBox.padding.top customFields.appearance.groupBox.padding.bottom customFields.appearance.groupBox.margin.left customFields.appearance.groupBox.margin.right customFields.appearance.groupBox.margin.top customFields.appearance.groupBox.margin.bottom customFields.appearance.inputBox.border.width customFields.appearance.inputBox.border.color customFields.appearance.inputBox.border.radius customFields.appearance.inputBox.background.color customFields.appearance.inputBox.font.color customFields.appearance.inputBox.font.size customFields.appearance.inputBox.font.weight customFields.appearance.inputBox.shadows customFields.appearance.inputBox.padding.left customFields.appearance.inputBox.padding.right customFields.appearance.inputBox.padding.top customFields.appearance.inputBox.padding.bottom customFields.appearance.inputBox.margin.left customFields.appearance.inputBox.margin.right customFields.appearance.inputBox.margin.top customFields.appearance.inputBox.margin.bottom customFields.appearance.inputBox.labelFont.color customFields.appearance.inputBox.labelFont.size customFields.appearance.inputBox.labelFont.weight customFields.appearance.inputBox.height customFields.validations statuses types
  • limitinteger

    0–20 · default 20

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

  • includeArchivedboolean

    default false

  • archivedboolean
  • userFilterstringnullable
  • searchTermstring

    1–100 characters

  • topicIdsid[]

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

Response

200 Successful response

Content-Type: application/json

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

      1–80 characters

    • identifierstring

      1–4 characters

    • lastSequenceNumberinteger

      at least 0

    • 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 10000 characters

    • revisioninteger

      at least 0

    • openCountinteger

      at least 0

    • closedCountinteger

      at least 0

    • archivedAtstring · date-timenullable
    • archivedByobjectnullable
    • customFieldsobjectnullable
      5 properties
      • groupsobject[]
        12 properties
        • idstring

          1–24 characters

        • pageIdstring

          1–24 characters

        • labelstring

          at most 140 characters

        • hintstring

          at most 280 characters

        • fieldsobject[]
        • disabledboolean | object
          2 properties
          • operatorstring
            and or
          • conditions(object (recursive) | object)[]

            at least 1 items

            4 properties
            • leftobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • cmpFuncstring
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • negateboolean
        • hiddenboolean | object
          2 properties
          • operatorstring
            and or
          • conditions(object (recursive) | object)[]

            at least 1 items

            4 properties
            • leftobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • cmpFuncstring
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • negateboolean
        • minItemsinteger

          at least 0

        • maxItemsinteger
        • addItemCaptionstring

          at most 64 characters

        • itemCaptionstring

          at most 100 characters

        • itemModestring
          noHeader draggable
      • pagesobject[]
        3 properties
        • idstring

          1–24 characters

        • labelstring

          1–40 characters

        • hintstring

          at most 280 characters

      • submitCaptionstring
      • appearanceobject
        5 properties
        • accentColorstring
        • accentTextColorstring
        • boxobject
          6 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • fontobject
            3 properties
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumber
            • ynumber
            • blurnumber

              at least 0

            • spreadnumber

              at least 0

            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

        • groupBoxobject
          6 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • fontobject
            3 properties
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumber
            • ynumber
            • blurnumber

              at least 0

            • spreadnumber

              at least 0

            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

        • inputBoxobject
          8 properties
          • borderobject
            3 properties
            • widthnumber
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • radiusnumber
          • backgroundobject
            1 property
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • fontobject
            3 properties
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • sizenumber

              at least 1

            • weightnumber
          • shadowsobject[]
            5 properties
            • xnumber
            • ynumber
            • blurnumber

              at least 0

            • spreadnumber

              at least 0

            • colorstring

              pattern ^#[0-9A-F]{6,8}$

          • paddingobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • marginobject
            4 properties
            • leftnumber

              at least 0

            • rightnumber

              at least 0

            • topnumber

              at least 0

            • bottomnumber

              at least 0

          • labelFontobject
            3 properties
            • colorstring

              pattern ^#[0-9A-F]{6,8}$

            • sizenumber

              at least 1

            • weightnumber
          • heightnumber

            at least 0

      • validationsobject[]
        2 properties
        • conditionobject
          2 properties
          • operatorstring
            and or
          • conditions(object (recursive) | object)[]

            at least 1 items

            4 properties
            • leftobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • cmpFuncstring
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • negateboolean
        • messagestring

          1–500 characters

    • statusesobject[]

      2–100 items

      6 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
      • orderinteger

        at least 0

      • archivedAtstring · date-timenullable
    • typesobject[]

      1–50 items

      7 properties
      • _idid
      • namestring

        1–80 characters

      • emojistring

        at most 16 characters

      • orderinteger

        at least 0

      • archivedAtstring · date-timenullable
      • statusesid[]

        2–30 items

      • statusTransitionsobject[]nullable

        at most 30 items

        2 properties
        • fromStatusid
        • toStatusesid[]

          1–30 items

  • countinteger

    at least 0

Response200
{
  "topics": [
    {
      "_id": "000000000000000000000001",
      "organization": "000000000000000000000001",
      "name": "string",
      "identifier": "string",
      "lastSequenceNumber": 0,
      "color": "slate",
      "description": "string",
      "revision": 0,
      "openCount": 0,
      "closedCount": 0,
      "archivedAt": "2026-06-15T22:30:00Z",
      "archivedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "customFields": {
        "groups": [
          {
            "id": "string",
            "label": "string",
            "fields": [
              {
                "id": "string",
                "type": "placeholder",
                "name": "string"
              }
            ]
          }
        ]
      },
      "statuses": [
        {
          "_id": "000000000000000000000001",
          "label": "string",
          "color": "slate",
          "role": "regular",
          "order": 0,
          "archivedAt": "2026-06-15T22:30:00Z"
        }
      ],
      "types": [
        {
          "_id": "000000000000000000000001",
          "name": "string",
          "emoji": "string",
          "order": 0,
          "archivedAt": "2026-06-15T22:30:00Z",
          "statuses": [
            "000000000000000000000001"
          ],
          "statusTransitions": [
            {
              "fromStatus": "000000000000000000000001",
              "toStatuses": [
                "000000000000000000000001"
              ]
            }
          ]
        }
      ]
    }
  ],
  "count": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.