Label Templates

List Label Templates

get

Retrieves a paginated list of standard label templates provided by Patchworks. Can be filtered by name.

Authorizations
AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters
filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, name

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
chevron-right
200

Successful response

No content

get
/api/v1/patchworks/label-templates

No content

Get Label Template

get

Retrieves the details of a specific label template.

Authorizations
AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters
label_templatestringRequired

The label template identifier.

Query parameters
filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, name

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
chevron-right
200

Successful response

No content

get
/api/v1/patchworks/label-templates/{label_template}

No content

Last updated

Was this helpful?