canonical: https://jentic.com/apis/myjgid.com/jgid

# Myjgid JGID API

Jentic publishes the only available OpenAPI specification for JGID API, keeping it validated and agent-ready. JGID is an Australian-built job management and CRM platform used by trades, manufacturers, and field-service businesses to run the full quote-to-invoice workflow. The API exposes 18 endpoints split into a CRM module (clients, contacts, locations, suppliers), a workflow module (enquiries, quotes, orders, jobs, invoices), an inventory module (instruments, services, materials), and a time-tracking surface for timesheets. Authentication is HTTP bearer against https://myjgid.com.

## For AI agents

Manage clients, enquiries, quotes, jobs, invoices, inventory, and timesheets in a JGID workspace using a bearer token.

## Scope

Does not handle payroll processing, payment capture, or marketing automation - use for trades job management across CRM, quotes, jobs, invoices, and timesheets only.

## Capabilities

- Maintain the CRM contact graph across `/api/v2/crm/clients`, /contacts, /locations, and /suppliers
- Open new sales enquiries via POST `/api/v2/workflow/enquiries` to start the quote-to-invoice journey
- Inspect quote, order, job, and invoice records by ID through the `/api/v2/workflow/{type}/{id}` endpoints
- Read inventory across instruments, services, and materials for quote line-item reference data
- Pull timesheet data via GET `/api/v2/timetracking/timesheets` for payroll and job-cost reconciliation

## Use cases

### Lead-to-Enquiry Capture

Capture website or chatbot leads as JGID enquiries to kick off the quote-to-invoice workflow. The integration calls POST `/api/v2/crm/clients` (or finds the existing client), then POST `/api/v2/workflow/enquiries` with the scope of work and the client ID. This means leads land in the same workflow trades use day-to-day rather than in a separate spreadsheet.

Example prompt: Call POST `/api/v2/crm/clients` for the new lead, then POST `/api/v2/workflow/enquiries` with the client ID and the project description.

### Quote-to-Invoice Status Tracking

Track the full quote-order-job-invoice chain for a JGID workspace by calling GET `/api/v2/workflow/quotes/{id}`, `/orders/{id}`, `/jobs/{id}`, and `/invoices/{id}` as records progress. The integration writes status changes to a Slack channel or BI tool so operations leads see live pipeline state without logging into JGID.

Example prompt: Fetch GET `/api/v2/workflow/jobs/{id}` for active jobs, then GET `/api/v2/workflow/invoices/{id}` for the linked invoice to confirm whether each job has been billed.

### Inventory and Materials Lookup

Surface JGID's inventory across instruments, services, and materials inside a quoting tool or chatbot via GET `/api/v2/inventory/instruments`, /services, and /materials. The integration powers autocomplete and unit-price lookup so quote line items match what's actually catalogued in JGID.

Example prompt: Call GET `/api/v2/inventory/materials`, filter by name 'concrete', and return the matching items with their unit prices and SKU codes.

### Timesheet Export for Payroll

Pull JGID timesheets into a payroll system using GET `/api/v2/timetracking/timesheets.` The integration runs nightly, joins entries with internal employee IDs, and writes the gross hours per worker into the payroll inbox. This avoids manual export from the JGID portal at the end of every pay cycle.

Example prompt: Call GET `/api/v2/timetracking/timesheets` for the current pay period and write the per-employee total hours to the payroll system.

### AI Agent Job Management Concierge

An AI agent acts as a back-office assistant for a trades business. It searches Jentic for JGID operations, loads the client and enquiry schemas, and chains GET `/api/v2/crm/clients`, POST `/api/v2/crm/clients`, and POST `/api/v2/workflow/enquiries` to take a phone-call lead from a tradie's voicemail and produce a JGID enquiry. Jentic isolates the bearer token so the agent never holds the workspace secret.

Example prompt: Search Jentic for 'create a JGID enquiry from a new lead', execute POST `/api/v2/crm/clients`, then POST `/api/v2/workflow/enquiries` with the project scope.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v2/crm/clients` | List clients |
| POST | `/api/v2/crm/clients` | Create a client |
| POST | `/api/v2/workflow/enquiries` | Create a sales enquiry |
| GET | `/api/v2/workflow/quotes/{id}` | View a quote |
| GET | `/api/v2/workflow/jobs/{id}` | View a job |
| GET | `/api/v2/workflow/invoices/{id}` | View an invoice |
| GET | `/api/v2/inventory/materials` | List materials |
| GET | `/api/v2/timetracking/timesheets` | List timesheets |

## Key resources

- **CRM Clients** — List and create clients on `/api/v2/crm/clients.`
- **CRM Contacts** — List and create contacts attached to clients.
- **CRM Locations** — List and create job-site locations.
- **CRM Suppliers** — List and create supplier records.
- **Workflow Enquiries** — Create new sales enquiries that seed quotes, orders, jobs, and invoices.
- **Workflow Records** — View quote, order, job, and invoice records by ID.
- **Inventory** — Read instruments, services, and materials catalogues for quote line items.
- **Time Tracking** — Read timesheet entries for payroll and job-cost workflows.

## Why Jentic

- **Setup:** Wiring JGID by hand means managing its bearer token, targeting myjgid.com, and passing the Authorization header across its CRM, workflow, inventory, and timesheet calls yourself. Through Jentic you install once, import JGID from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** JGID puts the record id in the URL path (`/api/v2/workflow/quotes/{id}`, `/api/v2/workflow/jobs/{id}`), so a rule can pin your agent to one quote or job and nothing else. You choose the operations it may call, so writes like creating a client are not included unless you add them.
- **Credential handling:** Your JGID bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a JGID enquiry' or 'look up a job', and Jentic returns the matching JGID operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot CRM Contacts API** — HubSpot Contacts is a horizontal CRM with broader marketing and pipeline depth than JGID's trades focus.
- **Pipedrive API** — Pipedrive is a deal-pipeline CRM that can replace JGID's CRM module for sales-only teams.
- **Stripe API** — Stripe handles invoice payment collection that pairs with JGID's invoice generation.

## FAQ

### Why is there no official OpenAPI spec for JGID API?

JGID does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call JGID API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the JGID API use?

The JGID API uses HTTP bearer authentication - every request must include `Authorization: Bearer {Token}`. Through Jentic, the bearer token sits in the encrypted vault and is injected at execution time, so agent code and prompts never see the raw workspace secret.

### Can I create an enquiry with the JGID API?

Yes. Call POST `/api/v2/workflow/enquiries` with the linked client ID and the scope of the job. The created enquiry feeds the standard JGID quote-order-job-invoice workflow, which you can then read back through the `/api/v2/workflow/quotes/{id}`, `/orders/{id}`, `/jobs/{id}`, and `/invoices/{id}` endpoints.

### How do I track a job through Jentic?

Search Jentic for 'view a JGID job', load the GET `/api/v2/workflow/jobs/{id}` schema, and execute it with the job ID. Chain GET `/api/v2/workflow/invoices/{id}` for the linked invoice to determine whether the job has been billed.

### Can I export timesheets for payroll?

Yes. Call GET `/api/v2/timetracking/timesheets` to retrieve timesheet entries. Filter by date range and employee, then write the totals into your payroll system. This is the canonical export path - the spec does not include a paginated bulk-export variant beyond the list endpoint.

### What are the rate limits for the JGID API?

The published spec does not document explicit rate limits. Treat the API as throttled in production, implement exponential backoff on 429 responses, and contact JGID support for workspace-specific limits before running large bulk syncs of enquiries or jobs.

### Can I limit what my agent is allowed to do with the JGID API?

Yes. Because you run Jentic One yourself, your own rules decide which JGID operations and credentials the agent may use. You choose the operations it can call, so read paths like GET `/api/v2/workflow/jobs/{id}` or GET `/api/v2/timetracking/timesheets` can be allowed while writes such as POST `/api/v2/crm/clients` or POST `/api/v2/workflow/enquiries` stay excluded unless you add them. Since JGID carries the record id in the URL path, a rule can pin the agent to a single quote or job and nothing else.