v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Customers

View

This endpoint allows you to view a list of customers in the system. You can filter the results based on various parameters.

get/Customers/View

Query parameters

uuidstring

Customer unique identifier.

vat_numberstring

Customer or Company VAT number.

emailstring

Customer email address.

skipstring

Example:0

Optional Query variable, From where you want to start take records.

takestring

Example:5

Optional Query variable required if skip have some value. Max 500. This means that you want take 5 records.

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Response

200

pagesinteger

countinteger

Example response

{
  "pages": 1,
  "count": 1,
  "customers": [
    {
      "company_uid": "0c35eb70-651f-40c2-a171-83f97c006459",
      "customer_name": "PSG Group LTD",
      "customer_uid": "3ef5c2f7-8945-4163-95c6-ef29ba0f6fa7",
      "vat_number": "513772222",
      "customer_number": "121",
      "phone": "033364343",
      "email": "dorons@starvision.co.il",
      "uid": "9ef5c2f2-8945-4163-95c6-ef29ba0f6fa7",
      "paying_vat": true,
      "created_at": "11/12/2020",
      "contacts": [
        {
          "full_name": "איש קשר לדוגמה",
          "cell_phone": "0546489751"
        }
      ]
    }
  ]
}