Get Task Templates

get

https://api.apicbase.com/api/v2/compliance/tasks/templates/

Returns a list of compliance task templates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns the compliance task templates visible to the user, newest first. Library users see all templates of the
library; outlet users only see the templates of the outlets they are connected to.

The possible values of type, the contents of type_specific per type, and the recurrence.frequency values are
listed on the Reference Values page.

Query Params

page

int32

Defaults to 1

A page number within the paginated result set.

page_size

int32

Defaults to 10

The number of items to return per page. The maximum is 200.

ordering

string

Order the results. The possible values are: name, type, assignee, ccp__name, created, modified. You can reverse the order by prepending "-" to the value.

name

string

Filter on the template name (case-insensitive, partial match).

outlet

string

Filter on the ID of an outlet the template is scheduled in.

assignee

string

Filter on the ID of the assigned user.

ccp

string

Filter on the ID of the linked critical control point.

type

string

enum

Filter on the template type slug. See Template types.

active

boolean

Filter on whether the template's schedule is active.

Responses

400

Invalid filter or pagination parameters.

403

User lacks permission to view the tasks dashboard.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200