Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

GET/{organizationId}/misc/todo/topics/{topicId}Reads only

Get todo topic

Gets one todo topic for an organization by topic ID, including its available workflows. The response may mask actor details depending on the caller’s 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 access to the organization.
  • The caller needs either todoTopic.read or todoItem.read.

Request

Path parameters

  • organizationIdidrequired
  • topicIdidrequired
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/YOUR_TOPIC_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–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

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

Errors

Other errors

StatusErrorWhen
403No fixed messageIf the caller has neither todoTopic.read nor todoItem.read, the endpoint returns HTTP 403.
404The todo topic was not foundIf the topic is not found in the organization, the endpoint returns HTTP 404 with message key routes.misc.todo.topics.notFound.

Errors nearly every request can meet are listed under Errors.