Contacts & Companies

The Contacts API (v2) manages end-user identities in the Aurion CS helpdesk. Contacts are the people who submit support requests; companies group contacts by organization.

List Contacts

cURL

curl "https://apps.aurionai.net/api/v2/contacts?limit=10&search=smith" \
  -H "X-API-Key: ak_live_xxxx"

Python

import requests

response = requests.get(
    "https://apps.aurionai.net/api/v2/contacts",
    headers={"X-API-Key": "ak_live_xxxx"},
    params={"limit": 10, "search": "smith"},
)
contacts = response.json()

TypeScript

const response = await fetch(
  "https://apps.aurionai.net/api/v2/contacts?limit=10&search=smith",
  {
    headers: { "X-API-Key": "ak_live_xxxx" },
  }
);
const contacts = await response.json();

Response:

{
  "data": [
    {
      "id": "ct_456",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "phone": "+33612345678",
      "company_id": "co_789",
      "company_name": "Acme Corp",
      "tags": ["vip"],
      "created_at": "2026-01-15T10:00:00Z"
    }
  ],
  "total": 3,
  "limit": 10,
  "offset": 0
}

Query Parameters:

Parameter	Type	Description
`search`	string	Search by name or email
`company_id`	string	Filter by company
`tags`	string	Comma-separated tag filter
`limit`	integer	Results per page (default: 25, max: 100)
`offset`	integer	Number of results to skip

Create Contact

curl -X POST "https://apps.aurionai.net/api/v2/contacts" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+33698765432",
    "company_id": "co_789",
    "tags": ["engineering"]
  }'

Get Contact

curl "https://apps.aurionai.net/api/v2/contacts/ct_456" \
  -H "X-API-Key: ak_live_xxxx"

Update Contact

curl -X PATCH "https://apps.aurionai.net/api/v2/contacts/ct_456" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+33698765432",
    "tags": ["vip", "engineering"]
  }'

Delete Contact

curl -X DELETE "https://apps.aurionai.net/api/v2/contacts/ct_456" \
  -H "X-API-Key: ak_live_xxxx"

Contact Activity

View the full activity history for a contact — conversations, tickets, calls:

curl "https://apps.aurionai.net/api/v2/contacts/ct_456/activity?limit=20" \
  -H "X-API-Key: ak_live_xxxx"

Contact Attachments

List files attached to a contact's conversations:

curl "https://apps.aurionai.net/api/v2/contacts/ct_456/attachments" \
  -H "X-API-Key: ak_live_xxxx"

Companies

Companies group contacts by organization and enable company-level reporting.

List Companies

curl "https://apps.aurionai.net/api/v2/companies?search=acme" \
  -H "X-API-Key: ak_live_xxxx"

Query Parameters:

Parameter	Type	Description
`search`	string	Search by company name
`tags`	string	Comma-separated tag filter
`limit`	integer	Results per page (default: 25, max: 100)
`offset`	integer	Number of results to skip

Create Company

curl -X POST "https://apps.aurionai.net/api/v2/companies" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "domain": "acme.com",
    "tags": ["enterprise"]
  }'

Update Company

curl -X PATCH "https://apps.aurionai.net/api/v2/companies/co_789" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": ["enterprise", "priority"]
  }'

Delete / Restore Company

Companies are soft-deleted and can be restored:

Delete

curl -X DELETE "https://apps.aurionai.net/api/v2/companies/co_789" \
  -H "X-API-Key: ak_live_xxxx"

Restore

curl -X POST "https://apps.aurionai.net/api/v2/companies/co_789/restore" \
  -H "X-API-Key: ak_live_xxxx"

Contact Sync

Sync contacts from your external CS provider (Freshdesk or Zendesk). These endpoints are under /api/v1/contacts.

Trigger Contact Sync

curl -X POST "https://apps.aurionai.net/api/v1/contacts/sync?mode=manual" \
  -H "X-API-Key: ak_live_xxxx"

Query Parameters:

Parameter	Type	Description
`mode`	string	`manual` (differential, default) or `full` (with reconciliation)

Response:

{
  "status": "completed",
  "created": 12,
  "updated": 5,
  "skipped": 0
}

Get Sync Settings

curl "https://apps.aurionai.net/api/v1/contacts/settings" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "auto_sync_enabled": true,
  "sync_interval_hours": 8,
  "last_synced_at": "2026-04-09T06:00:00Z"
}

Update Sync Settings

curl -X PUT "https://apps.aurionai.net/api/v1/contacts/settings" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "auto_sync_enabled": true,
    "sync_interval_hours": 12
  }'

Sync History

View recent sync operations and their outcomes:

curl "https://apps.aurionai.net/api/v1/contacts/sync-history?limit=10" \
  -H "X-API-Key: ak_live_xxxx"

Contacts vs Requesters

Contacts (v2) are identities in the Aurion CS helpdesk — managed via this API
Requesters (v1) are identities synced from your external ITSM provider (Freshservice, HaloITSM, etc.)

Both can coexist when running ITSM + CS simultaneously.

Conversations — Manage conversations for contacts
Custom Fields — Add custom data fields to contacts
Webhooks — Subscribe to contact.* events

Required Scopes

Scope	Endpoints
`contacts:read`	`GET /v2/contacts`, `GET /v2/contacts/:id`, `GET /v2/companies`, `GET /v2/companies/:id`
`contacts:write`	`POST /v2/contacts`, `PATCH /v2/contacts/:id`, `DELETE /v2/contacts/:id`, `POST /v2/companies`, `PATCH /v2/companies/:id`
`config:read`	`GET /v1/contacts/settings`, `GET /v1/contacts/sync-history`
`config:write`	`PUT /v1/contacts/settings`, `POST /v1/contacts/sync`

Contacts & Companies

On this page