Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Cases

List all cases

Returns a list of all cases created in your Dotfile workspace.

See also

Learn more about Cases
Learn more about Filtering, Sorting and Pagination

get/v1/cases

Query parameters

include_custom_propertiesboolean

Include custom properties in the response, default false

external_idstring

Filter items by the external_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

assignee_idstring

Filter items by the assignee_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

namestring

Filter items by the name.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.

tagsstring

Filter items by the tags.{operator} field.
You can use the array_contains, array_not_contains and array_overlap operators, the array_contains operator being the default.
Comma separated for multiple values (array_contains, array_not_contains and array_overlap).

status'draft' | 'open' | 'approved' | 'rejected' | 'closed'

Filter items by the status.{operator} field.
You can use the eq, not_eq, in and not_in operators, the eq operator being the default.
Comma separated for multiple values (in and not_in).

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

updated_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

last_activity_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the last_activity_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field created_at.
Available fields are created_at, last_activity_at and name.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of cases created in the workspace

ℹ️ Click to see full payload

Example response

{
  "data": [
    {
      "custom_properties": {
        "custom_text": "Custom properties text",
        "custom_boolean": true,
        "custom_date": "2012-12-12",
        "custom_countries": [
          "FR"
        ],
        "custom_choices": [
          "option1",
          "option2"
        ],
        "custom_numeric": 12.3,
        "custom_property": null
      }
    }
  ],
  "pagination": {
    "count": 42
  }
}