List custom properties per entity type

get

https://api.dotfile.com/v1/custom-properties/{target_entity}

Returns a paginated list of custom properties for a given entity type. Options are not included in this list; use the detail endpoint to retrieve options.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

target_entity

string

enum

required

Entity type to retrieve custom properties for.

Allowed:

Query Params

label

string

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

key

string

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

include_archived

boolean

Include archived custom properties.
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.

sort

string

Defaults to created_at

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, key and label.

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.

200List of custom properties for entity type ℹ️ Click to see full payload