Get

GET

/operations/checklists/v1/:checklist_id

GET

/operations/checklists/v1/:checklist_id

1 const url = 'https://localhost:8000/operations/checklists/v1/checklist_id';
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   "schema_version": 1,
3   "name": "Pre-Flight Cargo Checklist",
4   "_id": "chk_9f8b7c6d5a4e3f2b1c0d",
5   "org_id": "org_12345abcde",
6   "created_by_user_id": "user_67890fghij",
7   "created_at_timestamp": "2024-01-15T09:30:00Z",
8   "updated_at_timestamp": "2024-01-15T09:30:00Z",
9   "description": "Checklist to verify all cargo and flight preparations before departure.",
10   "checks": [
11     {
12       "check": "shipping.order.placed.order_details_reviewed"
13     }
14   ],
15   "archived": false
16 }

Retrieves a single Checklist by id. | authz: min_org_role=operator | () -> (Checklist1)

Authentication

AuthorizationBearer

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

Path parameters

checklist_idstringRequired

Response

Successful Response

schema_versioninteger

namestring<=512 characters

_idstring

org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

created_at_timestampdatetime

updated_at_timestampdatetime

descriptionstring<=8192 characters

checkslist of objects

archivedbooleanDefaults to false

Errors

422

Checklists Get V1request Unprocessable Entity Error