Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Cases

Retrieve a case

Returns detailed information about the specified case.

See also

Learn more about Cases

get/v1/cases/{id}

Path parameters

idstring required

Retrieve a case by its Dotfile internal id first and if not found, by its external_id.

Query parameters

include_not_relevantboolean

Include companies and individuals marked as not relevant, default false

exclude_internal_checksboolean

Exclude companies and individuals checks that are marked as internal

property_originboolean

Include property origin details for companies and individuals in the response, default false

Response

ℹ️ Click to see full payload

idstring uuid required
namestring required
status'draft' | 'open' | 'approved' | 'rejected' | 'closed' required
external_idstring nullable required
space_slugstring nullable required
template_idstring uuid nullable required

Prefer using template.key instead.

contact_has_actionsboolean required
reviewer_has_actionsboolean required
flagsstring[] required

all_checks_approved for_review for_first_collect for_recollection first_collect_completed

tagsstring[] required
custom_propertiesobject required

Custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to read the case.

Archived custom properties are omitted.

metadataobject nullable required

Object in a format of key (string) / value (string)

last_activity_atstring date-time required

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

last_contact_action_atstring date-time nullable required

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

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "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
  },
  "individuals": [
    {
      "banking_information": {
        "iban": "FR7630006000011234567890189",
        "bic": "AGRIFRPPXXX"
      },
      "phone_number": "+33601234567",
      "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
      }
    }
  ],
  "companies": [
    {
      "banking_information": {
        "iban": "FR7630006000011234567890189",
        "bic": "AGRIFRPPXXX"
      },
      "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
      }
    }
  ]
}