Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Document check

List all document types

Returns a list of all document types created in your Dotfile workspace.

See also

Learn more about Document check

get/v1/document_types

Query parameters

labelstring

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

keystring

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

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.

include_archivedboolean

Include archived custom document types.
Default is false

sortstring

Use this parameter to sort query results.
If not specified, sorted in descending order with values of field created_at.
Available fields are created_at, key, label and updated_at.

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 document types created in the workspace

ℹ️ Click to see full payload

Example response

{
  "data": [
    {
      "key": "some_key"
    }
  ],
  "pagination": {
    "count": 42
  }
}