API REFERENCE

Contacts API

A contact is a person at one of your clients — the human you email, call, and open tickets for. Use this API to create and update contacts, tie them to a client, and pull the list out for search or export.

Create a contact

full_name and email are required. Set client_id to attach the person to a company, and use phone_numbers and additional_email_addresses for the rest of their contact details.

curl
curl https://algapsa.com/api/v1/contacts \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Priya Menon",
    "email": "priya@riversidedental.example",
    "client_id": "cl_3f9a2c",
    "role": "Office Manager"
  }'

Find and export

GET /contacts lists and filters, GET /contacts/search runs a text query, and GET /contacts/export pulls the set for a download. GET /contacts/stats returns aggregate counts. To list only the people at a single client, the Clients API exposes GET /clients/{id}/contacts.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.

GET/api/v1/contactsAlgaPSAAlgaDeskList contactsPOST/api/v1/contactsAlgaPSAAlgaDeskCreate contactGET/api/v1/contacts/{id}AlgaPSAAlgaDeskGet contactPUT/api/v1/contacts/{id}AlgaPSAAlgaDeskUpdate contactDELETE/api/v1/contacts/{id}AlgaPSAAlgaDeskDelete contactGET/api/v1/contacts/exportAlgaPSAAlgaDeskExport contactsGET/api/v1/contacts/searchAlgaPSAAlgaDeskSearch contactsGET/api/v1/contacts/statsAlgaPSAAlgaDeskGet contact stats