List template collections

Embed API

API Reference

Request

Fetch the available template collections.

To fetch templates that belong to a collection, refer to the GET /api/templates endpoint and use filter[collection].

Security

APIKey

Query

per_pageinteger, [ 1 .. 100 ]

Number of items per page.

Default:15

Example:per_page=20

pageinteger, >= 1

Page number to retrieve. Defaults to 1.

Default:1

Example:page=1

filter[query]string, <= 200 characters

Filter collections by a partial match against the localized title.

Example:filter[query]=HR

sortstring, <= 200 characters

Sort order for the template collection list. Use the field name for ascending order, or prefix with - for descending order (for example, title sorts by localized title ascending; -title sorts descending).

Allowed sort fields: title, id, and updated_at.

When sorting by title, set sort_locale to control which translation is preferred for the comparison. If sort_locale is omitted, the API compares titles using a fallback across all supported languages.

Example:sort=title

sort_localestring

Locale code used when sorting by title: that language’s string is preferred when comparing titles (other languages are still used as fallback). Must be one of the supported Builder language codes. Ignored when the active sort does not use localized title.

Enum:"en""en-US""en-GB""en-AU""en-CA""en-IN""en-NZ""en-ZA""es""pt"

Example:sort_locale=en-GB

Acceptstringrequired

Specify the response format.

Value:"application/json"

curl -i -X GET \
  'https://api.builder.docue.com/api/template-collections?per_page=20&page=1&filter%5Bquery%5D=HR&sort=title&sort_locale=en-GB' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successful response with a list of template collections.

Bodyapplication/json

dataArray of objects(TemplateCollectionData)

metaobject(ResponseMeta)

Response

{
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "status": { … },
    "pagination": { … }
  }
}