List agency IDs that have subscribed to your HawkSoft vendor app.

Returns an array of integer agency IDs. Each represents an independent insurance agency that has opted in to data sharing with your app via the HawkSoft License Management Portal.

List offices configured under an agency.

Args: agency_id: HawkSoft agency ID (from list_agencies).

List client IDs that changed since a given timestamp.

The workhorse for syncing. Pass an as_of ISO 8601 timestamp to get only clients modified after that point; omit it to get all clients. Then use get_client or get_clients_bulk on each ID.

Args: agency_id: HawkSoft agency ID. as_of: ISO 8601 timestamp (e.g. 2026-06-01T00:00:00Z). Omit for full list. office_id: Restrict to a specific office. include_deleted: Include soft-deleted clients.

Fetch full details for a single client.

Returns the full client object — details, people, contacts, claims, policies by default. Use include to narrow the response and save bandwidth.

Args: agency_id: HawkSoft agency ID. client_id: HawkSoft client number. include: Sections to include: details, people, contacts, claims, policies, invoices.

Fetch multiple clients in one call (up to 200 per request).

Args: agency_id: HawkSoft agency ID. client_numbers: List of client numbers (1–200 per call).

Find a client by exact policy number match.

Useful when an agent has a policy number from a carrier but not the HawkSoft client number. Returns all clients (usually 1) holding that policy. Exact match only — no partial or fuzzy search.

Args: agency_id: HawkSoft agency ID. policy_number: Exact policy number. include: Sections to include.

Append a log note (and optional follow-up task) to a client's record.

The single most useful write tool — call this whenever the agent does anything that should be visible in HawkSoft: a phone call, an email, a conversation summary, a carrier touch.

Args: agency_id: HawkSoft agency ID. client_id: HawkSoft client number. channel: Friendly channel name (e.g. "Phone From Insured") or LogAction int. description: One-sentence summary shown in the activity feed. body: Full note text. May be multi-line. ref_id: Unique UUID for idempotency. Auto-generated if omitted. ts: ISO 8601 timestamp. Defaults to now (UTC). policy_id: Optional policy GUID to link the note to. policy_index: Optional 1-based index on the policy. action: Optional action code. task_title: Set to create a follow-up task. task_description: Task description. task_due_date: ISO 8601 due date. task_assigned_to_role: One of SpecifiedUser, Producer, CSR, Agent1, Agent2, Agent3. task_assigned_to_email: Required when assigned_to_role is SpecifiedUser. task_category: Optional category label.

Attach a base64-encoded file (PDF, image, doc) to a client record.

Args: agency_id: HawkSoft agency ID. client_id: HawkSoft client number. channel: Channel name or LogAction int (use list_channels for the catalog). desc: One-line description of the file. log_note: Log note text tied to this attachment. file_name: File name including extension, e.g. "declaration_page.pdf". file_b64: Base64-encoded file contents — NO data: URL prefix. policy_id: Optional policy GUID to link to. ref_id: Idempotency UUID (auto-generated if omitted). ts: ISO 8601 timestamp (defaults to now). task_title, task_description, task_due_date, task_assigned_to_role, task_assigned_to_email, task_category: Optional follow-up task.

Record one or more payments received by a client.

Each receipt applies to one or more invoices. A log note is automatically created and linked. Optionally create a follow-up task.

Args: agency_id: HawkSoft agency ID. client_id: HawkSoft client number. receipts: List of receipts. Each item must include: - channel: channel name or int - logNote: text of the log note - total: total amount received - invoices: list of {"invoiceId": "<guid>", "amount": <float>} Optional per receipt: refId, ts, policyId, officeId, payMethod, task.

Return all 56 HawkSoft channel codes with friendly names and categories.

Use this to discover the right channel value to pass into create_log_note, create_attachment, or create_receipts.