List all checks

get

https://api.dotfile.com/v1/checks

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

See also

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

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

individual_id

string

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

company_id

string

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

status

string

enum

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

Allowed:

type

string

enum

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

exclude_internal

boolean

Exclude checks that are marked as internal.
Default is false

include_not_relevant

boolean

Include checks from individuals marked as not relevant.
Default is false

created_at

string

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_at

string

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_at

string

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.

sort

string

Defaults to updated_at

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

page

number

≥ 1

Defaults to 1

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

limit

number

1 to 100

Defaults to 20

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

Responses

400

The request is either malformed or contain invalid parameters.

One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.
If specified, make sure the value of the page or limit query parameter are valid.
Value of the sort parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json