Clients and contacts

These endpoints need the Clients area of the key's role. See Keys and permissions.

Clients

Read

The list includes archived clients.

curl -G https://itflow.example.com/api/v1/clients/read.php \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "client_name=Ravenwood Dental Group"

{
  "success": "True",
  "count": 1,
  "data": [
    {
      "client_id": "1",
      "client_name": "Ravenwood Dental Group",
      "client_type": "Healthcare",
      "client_website": "https://www.ravenwooddental.example",
      "client_rate": "145.00",
      "client_currency_code": "USD",
      "client_net_terms": "15",
      "client_abbreviation": "RDG",
      "client_archived_at": null,
      "tags": [ { "tag_id": 8, "tag_name": "Key Account", "tag_kind": "client", "tag_color": "#ffc107", "tag_icon": "star" } ]
    }
  ]
}

Fields: client_id, client_name, client_type, client_website, client_referral, client_rate, client_currency_code, client_net_terms, client_reminders, client_tax_id_number, client_default_tax_id, client_tax_exempt, client_tax_exempt_number, client_tax_exempt_expires, client_abbreviation, client_lead, client_notes, client_favorite, client_created_at, client_updated_at, client_archived_at, client_accessed_at, tags.

Create

Don't send client_id - the new client gets one, returned as insert_id.

curl -X POST https://itflow.example.com/api/v1/clients/create.php \
  -H "Content-Type: application/json" \
  -d '{"api_key": "YOUR_API_KEY", "client_name": "Allegheny Pet Hospital", "client_type": "Veterinary", "client_rate": 140, "client_net_terms": 30, "client_currency_code": "USD"}'

{ "success": "True", "count": "1", "data": [ { "insert_id": 27 } ] }

A client made through the API has no locations or contacts yet. Add them with locations and contacts.

Update, archive and unarchive

Send client_id and any of the fields under Create. Only what you send changes.

{ "api_key": "YOUR_API_KEY", "client_id": 27, "client_rate": 150, "client_notes": "Two clinics, one front desk." }

archive.php and unarchive.php take just client_id. Archiving a client also stops their recurring invoices.

Delete

delete.php takes client_id, and needs Full on Clients. The client has to be archived first.

Contacts

Read

The list includes archived contacts.

curl -G https://itflow.example.com/api/v1/contacts/read.php \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "contact_email=dprescott@ravenwooddental.example"

{
  "success": "True",
  "count": 1,
  "data": [
    {
      "contact_id": "2",
      "contact_name": "Dana Prescott",
      "contact_title": "Office Manager",
      "contact_email": "dprescott@ravenwooddental.example",
      "contact_phone": "4125550100",
      "contact_mobile": "4125550101",
      "contact_primary": "0",
      "contact_billing": "1",
      "contact_location_id": "1",
      "contact_client_id": "1",
      "tags": [ { "tag_id": 30, "tag_name": "Billing", "tag_kind": "contact", "tag_color": "#28a745", "tag_icon": "file-invoice-dollar" } ]
    }
  ]
}

Fields: contact_id, contact_name, contact_title, contact_department, contact_email, contact_phone_country_code, contact_phone, contact_extension, contact_mobile_country_code, contact_mobile, contact_photo, contact_pin, contact_notes, contact_primary, contact_important, contact_billing, contact_technical, contact_ticket_emails, contact_company_ticket_emails, contact_location_id, contact_vendor_id, contact_user_id, contact_client_id, contact_created_at, contact_updated_at, contact_archived_at, contact_accessed_at, tags.

Create

curl -X POST https://itflow.example.com/api/v1/contacts/create.php \
  -H "Content-Type: application/json" \
  -d '{"api_key": "YOUR_API_KEY", "client_id": 1, "contact_name": "Janelle Ortiz", "contact_email": "jortiz@ravenwooddental.example", "contact_title": "Office Manager", "contact_mobile": "412-555-0144", "contact_location_id": 2, "contact_billing": 1}'

Update, archive, unarchive and delete

Each takes contact_id and client_id, the contact's own client. update.php also takes any of the fields under Create, and changes only what you send. Archiving a contact also archives their client portal sign-in. delete.php needs Full on Clients, and the contact has to be archived first.

Locations

Read

Archived locations are left out.

{
  "success": "True",
  "count": 2,
  "data": [
    { "location_id": "1", "location_name": "Main Office", "location_address": "1140 Ridge Avenue", "location_city": "Pittsburgh", "location_state": "PA", "location_zip": "15212", "location_primary": "1", "location_client_id": "1" },
    { "location_id": "2", "location_name": "Wexford Practice", "location_city": "Wexford", "location_primary": "0", "location_client_id": "1" }
  ]
}

Fields: location_id, location_name, location_description, location_country, location_address, location_city, location_state, location_zip, location_phone_country_code, location_phone, location_phone_extension, location_fax_country_code, location_fax, location_hours, location_photo, location_primary, location_notes, location_favorite, location_contact_id, location_client_id, location_created_at, location_updated_at, location_archived_at, location_accessed_at, tags.

Create

Update, archive, unarchive and delete

Each takes location_id and client_id, the location's own client. update.php also takes any of the fields under Create. Only active locations can be changed. delete.php needs Full on Clients, and the location has to be archived first. Deleting a location takes it off everything that was there, such as contacts, assets and tickets.

Vendors

A vendor belongs to a client - a supplier of theirs - or to no client, as one of your own suppliers.

Read

Archived vendors are left out.

{
  "success": "True",
  "count": 1,
  "data": [
    { "vendor_id": "2", "vendor_name": "Netgate", "vendor_phone": "512-555-0182", "vendor_website": "https://www.netgate.example", "vendor_account_number": "NG-90233", "vendor_client_id": "0" }
  ]
}

Fields: vendor_id, vendor_name, vendor_description, vendor_contact_name, vendor_contact_phone_country_code, vendor_contact_phone, vendor_contact_email, vendor_phone_country_code, vendor_phone, vendor_extension, vendor_email, vendor_website, vendor_status_page, vendor_portal, vendor_hours, vendor_sla, vendor_code, vendor_account_number, vendor_notes, vendor_favorite, vendor_client_id, vendor_template_id, vendor_created_at, vendor_updated_at, vendor_archived_at, vendor_accessed_at, tags.

Create

Update, archive and unarchive

Each takes vendor_id and client_id - the vendor's client, or 0 for one of your own. update.php also takes any of the fields under Create. Only active vendors can be changed. Vendors can't be deleted through the API.