Resources

GET
/api/v2/clients
List clients

Params

  • number

    Filter by client number

  • org_number

    Filter by client org.number

  • email

    Filter by client email

  • sort

    Allowed sort fields: number, name. The direction is specified by prefixing the field with +/- (+ for ASC, - for DESC). Example: “sort=+field,-secondary_field”

Examples

GET /api/v2/clients
200
{
  "data": [
    {
      "id": 3,
      "number": 1,
      "name": "Google Inc",
      "first_name": "",
      "last_name": "",
      "email": "",
      "fax": "",
      "phone": "",
      "home_phone": "",
      "mobile_phone": "",
      "client_type": "company",
      "org_number": "556677-8899",
      "settings": {
        "currency": "USD",
        "discount": 0,
        "email_attach_pdf": false,
        "invoice_days": 30,
        "invoice_delivery_method": "email",
        "invoice_template": "croatia",
        "locale": "sv",
        "prices_inc_tax": "no",
        "show_product_code": false,
        "tax": 25
      },
      "address": {
        "street_address": "1600 Amphitheatre Parkway",
        "care_of": "",
        "zip_code": "94043",
        "city": "Mountain View",
        "country": "SE"
      }
    }
  ],
  "paging": {
    "total_pages": 1,
    "current_page": 1,
    "next": null,
    "previous": null
  }
}