Clients API

A client is a company you bill and support — what some tools call a customer or account. Use this API to create and update clients, read them in bulk, and reach their contacts and locations.

Create a client

Only client_name and billing_cycle are required; contact details, address, payment terms, and tax ID are optional and can be filled in later. billing_cycle is one of weekly, bi-weekly, monthly, quarterly, semi-annually, or annually.

curl https://algapsa.com/api/v1/clients \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "client_name": "Riverside Dental Group",
    "billing_cycle": "monthly",
    "email": "ap@riversidedental.example",
    "payment_terms": "net_30"
  }'

Contacts and locations

A client owns its contacts and locations. List them with GET /clients/{id}/contacts and GET /clients/{id}/locations, and add a site with POST /clients/{id}/locations. Individual people are managed through the Contacts API.

Read clients

GET /clients lists and filters; pass a client ID to GET /clients/{id} for one record, or hit GET /clients/stats for aggregate counts.

Endpoints

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