---
canonical_url: "https://docs.composio.dev/toolkits/hello_tracks"
markdown_url: "https://docs.composio.dev/toolkits/hello_tracks.md"
product: "platform"
version: null
last_updated: null
---

# HelloTracks

HelloTracks is a location-based workforce management platform for dispatching jobs, optimizing routes, tracking mobile teams, and managing field operations.

- **Category:** project management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `HELLO_TRACKS`
- **Version:** 00000000_00

## Tools

### Archive Job

**Slug:** `HELLO_TRACKS_ARCHIVE_JOB`

Archive one HelloTracks job while keeping it recoverable in HelloTracks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | HelloTracks ID of the job to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Job

**Slug:** `HELLO_TRACKS_DELETE_JOB`

Permanently delete one HelloTracks job; use only for a disposable or intentionally removed job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | HelloTracks ID of the job to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Context

**Slug:** `HELLO_TRACKS_GET_ACCOUNT_CONTEXT`

Identify the connected HelloTracks account and return its company, teams, units, and API-enabled state.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Locations

**Slug:** `HELLO_TRACKS_GET_CURRENT_LOCATIONS`

Read precise latest-known GPS coordinates and available movement, elevation, and battery telemetry for selected visible HelloTracks members, optionally with addresses, without pinging their devices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member_ids` | array | Yes | One or more HelloTracks member IDs or usernames whose latest known locations should be returned. |
| `include_address` | boolean | No | Whether to reverse-geocode and include a readable address for each location. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `HELLO_TRACKS_GET_JOB`

Retrieve one HelloTracks job by its job ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | HelloTracks job ID returned by a list or upsert operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jobs

**Slug:** `HELLO_TRACKS_LIST_JOBS`

List HelloTracks jobs with optional time, progress, archive, external-ID, and assignee filters, returning one controllable page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `progress` | string | No | Filter by the HelloTracks job progress value. |
| `external_id` | string | No | Return the job matching this caller-assigned external ID. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page. |
| `created_since` | integer | No | Return jobs created at or after this Unix timestamp in milliseconds. |
| `updated_since` | integer | No | Return jobs updated at or after this Unix timestamp in milliseconds. |
| `include_archived` | boolean | No | Whether archived jobs should be included. |
| `assignee_username` | string | No | Return jobs assigned to this exact HelloTracks username. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Members

**Slug:** `HELLO_TRACKS_LIST_MEMBERS`

Search visible HelloTracks members for identity and assignment details without returning location or device telemetry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Name, username, email, or other member text to search for. |
| `max_results` | integer | No | Maximum matching members to return; must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Places

**Slug:** `HELLO_TRACKS_LIST_PLACES`

Find visible HelloTracks places by name or place IDs for use in job planning.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Place name or address text to search for. |
| `place_ids` | array | No | Specific HelloTracks place IDs to retrieve. |
| `max_results` | integer | No | Maximum places to return. HelloTracks defaults to 500 when this value is omitted upstream. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Job

**Slug:** `HELLO_TRACKS_UPDATE_JOB`

Partially update the editable details of one existing HelloTracks job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Replacement scheduled date in YYYY-MM-DD format. |
| `notes` | string | No | Replacement instructions or notes. |
| `title` | string | No | Replacement job title. |
| `job_id` | string | Yes | HelloTracks ID of the job to update. |
| `address` | string | No | Replacement destination address or place description. |
| `contact` | object | No | Replacement contact with name, phone, and email fields. |
| `place_id` | string | No | Replacement associated HelloTracks place ID. |
| `priority` | integer | No | Replacement priority from 0 through 10. |
| `external_id` | string | No | Replacement caller-assigned external ID. |
| `time_window` | object | No | Replacement service window with start and end in HH:mm format. |
| `assignee_username` | string | No | Replacement assignee's exact HelloTracks username. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Job

**Slug:** `HELLO_TRACKS_UPSERT_JOB`

Create a HelloTracks job, or update the existing job when the supplied external ID already matches one.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Scheduled date in YYYY-MM-DD format. |
| `notes` | string | No | Instructions or notes for the assignee. |
| `title` | string | Yes | Short title describing the job. |
| `address` | string | No | Destination street address or place description. |
| `contact` | object | No | Optional destination contact with name, phone, and email fields. |
| `place_id` | string | No | Existing HelloTracks place ID to associate with the job. |
| `priority` | integer | No | Job priority from 0 through 10. |
| `external_id` | string | No | Caller-assigned deduplication ID; a match can update the existing job instead of creating another. |
| `time_window` | object | No | Optional service window with start and end values in HH:mm format. |
| `assignee_username` | string | No | Exact HelloTracks username to assign; use List Members to resolve it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |