Templates
2 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/templates | Search the template library by keyword, category, and tags |
| GET | /api/v1/templates/{templateId} | Fetch a template bundle by id |
Search the template library by keyword, category, and tags
GET/api/v1/templates
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | optional | Searches the template library using this text query. Applies to Search the template library by keyword, category, and tags. |
| category | string | optional | Filters templates to the requested category. Applies to Search the template library by keyword, category, and tags. |
| tags | array<string> | optional | Filters templates to entries carrying all requested tags. Applies to Search the template library by keyword, category, and tags. |
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to Search the template library by keyword, category, and tags. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to Search the template library by keyword, category, and tags. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Fetch a template bundle by id
GET/api/v1/templates/{templateId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | string | required | Identifies the template being addressed. Applies to Fetch a template bundle by id. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Template not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|