List

GET

/operations/checklists/list/v1

GET

/operations/checklists/list/v1

1 const url = 'https://localhost:8000/operations/checklists/list/v1?sort_by=created_at_timestamp&sort_order=asc&page=1&page_size=1&filter_archived=true';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "items": [
3     {
4       "schema_version": 1,
5       "name": "Pre-Flight Cargo Inspection",
6       "_id": "chk_8f3b2a1d9c4e4f7a9b2c3d4e",
7       "org_id": "org_7a9b2c3d4e5f6a7b8c9d0e1f",
8       "created_by_user_id": "user_1234567890abcdef",
9       "created_at_timestamp": "2024-01-15T09:30:00Z",
10       "updated_at_timestamp": "2024-04-20T14:45:00Z",
11       "description": "Checklist to verify all cargo details and documentation before flight departure.",
12       "checks": [
13         {
14           "check": "shipping.order.placed.order_details_reviewed"
15         },
16         {
17           "check": "shipping.task_artifact.image_uploaded.cargo_visible"
18         }
19       ],
20       "archived": false
21     }
22   ],
23   "total_count": 1
24 }

Lists Checklists for the caller’s organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (ChecklistListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_archivedbooleanOptional

Filter by archived flag. None=all, True=archived only, False=unarchived only.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Checklists List V1request Unprocessable Entity Error