List clients (GET /api/v1/clients)

Needs a token with the read:clients scope (or write:clients). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET

/api/v1/clients

GET

/api/v1/clients

Clients of the workspace, paged and filterable.

Authorization

bearerAuth

headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Query Parameters

page?integer

Page number, from 1.

Range1 <= value

Default1

page_size?integer

Items per page.

Range1 <= value <= 200

Default50

search?string

Matches name, number, email, city and more.

status?string

Comma-separated: active, inactive, draft, complete.

type?string

Companies or people.

Value in"company""person"

tag?string

A tag (case-insensitive).

country?string

Comma-separated ISO alpha-2 codes.

sort?string

One of number, name, email, city, created_at, updated_at; prefix - for descending. Default -created_at.

Response Body

application/json

response

data*array<>

meta*

Paging of a list: page/page_size in, totals out.

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/clients'

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/clients'

Example ResponseSchema

{
  "data": [
    {
      "id": "string",
      "number": 0,
      "name": "string",
      "preferred_name": "string",
      "is_company": true,
      "is_active": true,
      "email": "string",
      "billing_email": "string",
      "phone": "string",
      "website": "string",
      "street": "string",
      "street_number": "string",
      "apt": "string",
      "zip": "string",
      "city": "string",
      "country": "string",
      "vat_number": "string",
      "electronic_address": {
        "scheme": "string",
        "id": "string"
      },
      "registration_number": "string",
      "region": "string",
      "language": "de",
      "currency": "string",
      "payment_terms_days": 0,
      "internal_id": "string",
      "note": "string",
      "tags": [
        "string"
      ],
      "dunning_enabled": true,
      "einvoice_format": "none",
      "leitweg_id": "string",
      "portal_enabled": true,
      "portal_invited_at": "2019-08-24T14:15:22Z",
      "portal_signed_in_at": "2019-08-24T14:15:22Z",
      "contacts": [
        {
          "id": "string",
          "name": "string",
          "role": "string",
          "email": "string",
          "phone": "string",
          "is_primary": true
        }
      ],
      "is_draft": true,
      "missing_fields": [
        "string"
      ],
      "files_count": 0,
      "pending_change_request": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 0,
    "total": 0,
    "total_pages": 0
  }
}

{  "data": [    {      "id": "string",      "number": 0,      "name": "string",      "preferred_name": "string",      "is_company": true,      "is_active": true,      "email": "string",      "billing_email": "string",      "phone": "string",      "website": "string",      "street": "string",      "street_number": "string",      "apt": "string",      "zip": "string",      "city": "string",      "country": "string",      "vat_number": "string",      "electronic_address": {        "scheme": "string",        "id": "string"      },      "registration_number": "string",      "region": "string",      "language": "de",      "currency": "string",      "payment_terms_days": 0,      "internal_id": "string",      "note": "string",      "tags": [        "string"      ],      "dunning_enabled": true,      "einvoice_format": "none",      "leitweg_id": "string",      "portal_enabled": true,      "portal_invited_at": "2019-08-24T14:15:22Z",      "portal_signed_in_at": "2019-08-24T14:15:22Z",      "contacts": [        {          "id": "string",          "name": "string",          "role": "string",          "email": "string",          "phone": "string",          "is_primary": true        }      ],      "is_draft": true,      "missing_fields": [        "string"      ],      "files_count": 0,      "pending_change_request": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "page_size": 0,    "total": 0,    "total_pages": 0  }}

List clients

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body