> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesask.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workiz

> Connect Workiz to add notes to Clients and pull Jobs, Leads, and their scheduled visits.

Sales Ask adds a note to the Client of the matched Job or Lead, and pulls Jobs, Leads, and their scheduled visits.

## What Sales Ask uses in Workiz

| Object | How Sales Ask uses it |
| - | - |
| Jobs | Reads scheduled Jobs to match calls and sync price and status |
| Leads | Reads open Leads to match calls and sync status |
| Clients | Reads each Job's or Lead's Client for name, email, phone, and address |
| Client Notes | Adds a note to the Client, naming the Job or Lead it's about |
| Users | Matches reps to active Workiz users by email |
| Availability | Reads booking availability to work out your account's time zone |
| Job Sub-Statuses and Lead Statuses | Reads your statuses so you can map them to open, won, or lost |

## What you need

* **API Key** from Workiz's Developer API (v2)

You can use one key for the whole organization, or a separate key for each Sales Ask team. Each Workiz account needs its own key.

## Get your API key

1. In Workiz, go to **Settings → Developer** and open the **v2** tab.
2. Create an API key and name it `Sales Ask`.
3. Give the key **Read** access to Jobs, Leads, Users, and Availability, and **Read & Write** access to Clients.
4. Leave the expiration date empty. Sales Ask stops syncing when the key expires.
5. Copy the key as soon as Workiz shows it, and keep it somewhere safe.

> [!WARNING]
>
> Use a key from the **v2** tab. Sales Ask connects through Workiz's Developer API v2.

> [!NOTE]
>
> If you don't see **Developer** in your settings, turn on the Developer API add-on in Workiz's Feature Center first.

## Connect in Sales Ask

1. Go to **Settings → Integrations** and search for **Workiz**.
2. Choose organization-wide or per-team keys, then paste the key.
3. Choose a [matching method](/integrations/overview#matching-method) and click **Save**.

## How reps are matched

Each rep's Sales Ask email must match the email of an active Workiz user. A rep sees the Jobs and Leads they're assigned to.

## Where notes appear

Sales Ask adds each note to the Client of the matched Job or Lead. The note's first line names the Job or Lead it's about, for example `Sales Ask - Job #3020`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.