List

GET

/tracking/geofence_templates/list/v1

GET

/tracking/geofence_templates/list/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.tracking.geofenceTemplates.listV1({
8         filter_archived: true,
9         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
10         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
11         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
15         filter_owned_by_user_id: "filter_owned_by_user_id",
16         page: 1,
17         page_size: 1,
18         sort_by: "created_at_timestamp",
19         sort_order: "asc",
20     });
21 }
22 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "geofences": [
7         {
8           "display_name": "display_name",
9           "location": {
10             "geometry": {
11               "coordinates": [],
12               "type": "Point"
13             },
14             "type": "Feature"
15           },
16           "radius_miles": 1.1
17         }
18       ],
19       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
20       "name": "name",
21       "owned_by_org_id": "owned_by_org_id",
22       "owned_by_user_id": "owned_by_user_id",
23       "schema_version": 1,
24       "archived_at_timestamp": "2024-01-15T09:30:00Z",
25       "description": "description",
26       "last_used_at_timestamp": "2024-01-15T09:30:00Z"
27     }
28   ],
29   "total_count": 1
30 }

Lists geofence templates for the caller’s organization. | authz: min_org_role=operator | () -> (GeofenceTemplateListRes)

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.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_archivedbooleanOptionalDefaults to false

Include archived templates instead of active templates.

filter_owned_by_user_idstringOptional

Filter by the user that created the template.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value.

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value.

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter last_edited_at_timestamp >= value.

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter last_edited_at_timestamp <= value.

filter_last_used_at_timestamp_gtedatetimeOptional

Filter last_used_at_timestamp >= value.

filter_last_used_at_timestamp_ltedatetimeOptional

Filter last_used_at_timestamp <= value.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Geofence Templates List V1request Unprocessable Entity Error