List Kit Templates

Required permission: read_kit_templates

Returns a paginated list of kit templates for the organization. Supports filtering by client and kit product, and free-text search on the kit template name.

All filter parameters are optional. When no filters are provided, all kit templates accessible to the API key are returned. Client-level API keys are automatically scoped to their client; organization-level API keys may optionally scope results to a single client they own via client_id.

This endpoint uses cursor-based pagination. Use the next_cursor value from a response in the cursor parameter of the next request to fetch the following page; has_next_page indicates whether more results remain. For performance, this endpoint does not return total or filtered result counts.

Example use cases:

  • Get all kit templates: GET /kit-templates
  • Get kit templates for a client: GET /kit-templates?client_id=123
  • Get kit templates for a kit product: GET /kit-templates?product_id=456
  • Search kit templates by name: GET /kit-templates?search_value=starter
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

integer
≥ 1

Filter by kit product ID. Only returns kit templates whose kit product matches the specified product.

string
enum

Specifies the field by which to sort the results:

  • created_at: Sort by when the kit template was created.
  • updated_at: Sort by when the kit template was last updated.
  • name: Sort by the kit template name.
Allowed:
string

A value to search for within the items. The specific fields searched depend on the endpoint.

integer
1 to 100
Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

string
enum
Defaults to asc

Specifies the sort direction of the returned items:

  • asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
  • desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json