Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22399194.2 KB
Config Types

List

List config types.

get/config_types

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger
Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byConfigTypeOrderBy[]

Sort order for the config type results.

[
  "created_at:desc"
]
expandConfigTypeListExpansion[]

Fields to expand on each config type in the list.

idstring[]

The config type IDs to filter by.

[
  "cfg_typ_123"
]
namestring[]

The config type names to filter by.

[
  "Motion Control"
]
slugstring[]

The config type slugs to filter by.

[
  "motion-control"
]

Response

Successfully listed the config types.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "config_type",
      "id": "cfg_123",
      "name": "My Config Type",
      "slug": "my-config-type",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}