Untangly API Docs

Clients

List, retrieve, and create person clients.

Clients are the top-level entity in Untangly. A client is either a person or a business. This page covers person clients; see Businesses for business clients.

List clients

GET /clients

Query parameters

ParameterTypeDescription
searchstringFilter by name or email (case-insensitive)
type"person" | "business"Filter by client type
limitnumberMax results (default 50, max 100)
offsetnumberPagination offset (default 0)

Example

curl "https://api.untangly.com/clients?type=person&search=john" \
  -H "Authorization: Bearer mint_<key>"

Response

{
  "clients": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientType": "person",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john@example.com",
      "phone": "+1-555-0100",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-15T10:30:00.000Z"
    }
  ],
  "total": 1
}

Get client details

GET /clients/{id}

Path parameters

ParameterDescription
idClient UUID

Example

curl "https://api.untangly.com/clients/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer mint_<key>"

Add a person client

POST /clients/person

Request body

{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+1-555-0199"
}
FieldTypeRequiredDescription
firstNamestring
lastNamestring
emailstringMust be a valid email
phonestring

Example

curl -X POST https://api.untangly.com/clients/person \
  -H "Authorization: Bearer mint_<key>" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Jane","lastName":"Doe","email":"jane@example.com"}'

Response 201

{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "clientType": "person",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane@example.com",
  "phone": null,
  "createdAt": "2026-04-19T09:00:00.000Z",
  "updatedAt": "2026-04-19T09:00:00.000Z"
}

On this page