GET /checklists/{id}

Servers

Path parameters

Name Type Required Description
id String Yes

ID of a checklist.

Query parameters

Name Type Required Description
cards String No

Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.

Possible values:

  • "visible"
  • "open"
  • "closed"
  • "none"
  • "all"

Default value: "none"

checkItems String No

The check items on the list to return. One of: all, none.

Possible values:

  • "none"
  • "all"

Default value: "all"

checkItem_fields String No

The fields on the checkItem to return if checkItems are being returned. all or a comma-separated list of: name, nameData, pos, state, type, due, dueReminder, idMember

Possible values:

  • "dueReminder"
  • "state"
  • "pos"
  • "idMember"
  • "name"
  • "type"
  • "nameData"
  • "due"
  • "all"

Default value: "name, nameData, pos, state, due, dueReminder, idMember"

fields String No

all or a comma-separated list of checklist fields

Default value: "all"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.