Agiled Docs
Developers

CRM Endpoints

Use public API endpoints for contacts, accounts, deals, and tickets.

CRM public API endpoints are available under /public/v1.

Resources

  • /contacts
  • /accounts
  • /deals
  • /tickets

Each resource supports list, get, create, update, and delete operations when the API key has the required read or write ability.

Common Integration Patterns

Use CRM endpoints when another system needs to create leads, enrich customer records, sync support tickets, or move opportunities through a pipeline. Common sources include website forms, enrichment tools, support inboxes, migration scripts, and sales operations systems.

Decide the source of truth before syncing. For example, if Agiled owns pipeline stage and owner assignment, an external CRM import should not overwrite those fields after users start working the deal.

Useful Includes

  • Contacts: accounts, assigned_user, assigned_users
  • Accounts: contacts, assigned_user, assigned_users
  • Deals: account, contacts, assigned_user, assigned_users
  • Tickets: account, contact, assigned_user, project, related_task, invoice

Includes are helpful for dashboards and one-off lookups. For high-volume imports, fetch the base records first and request related records only when your integration needs them.

Before Creating CRM Records

Normalize incoming data before calling the API:

  • Trim names, email addresses, phone numbers, and company names.
  • Decide how duplicate contacts and accounts should be handled.
  • Map owners and assignees to Agiled users.
  • Map deal status and stage to the workspace pipeline.
  • Map ticket priority and status to the team's support process.

For imports, keep the external system's ID in your integration database so future updates do not create duplicate records.

After Syncing

Spot-check records from the Agiled UI. Confirm the contact or account appears in search, related deals and tickets link to the right customer, and assignments match the intended owner. If a record is missing from a user's view, check API key scope, workspace, module access, and role permissions.

CRM Rollout Checklist

Before enabling a broad CRM sync:

  1. Create one contact, account, deal, and ticket in a test workspace or safe segment.
  2. Confirm duplicate matching works for contacts and accounts.
  3. Confirm owner, pipeline, stage, status, and priority mappings.
  4. Check whether workflows trigger from created or updated CRM records.
  5. Review reports and saved views after the sample sync.

Fix mapping problems before importing a full customer list. CRM cleanup is much harder after sales, support, and finance teams start using the records.

On this page