Powershell / easybill REST API / Fetch customers list
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("limit","<integer>")
$queryParams.UpdateString("page","<integer>")
$queryParams.UpdateString("group_id","<string>")
$queryParams.UpdateString("additional_group_id","<string>")
$queryParams.UpdateString("number","<string>")
$queryParams.UpdateString("country","<string>")
$queryParams.UpdateString("zip_code","<string>")
$queryParams.UpdateString("emails","<string>")
$queryParams.UpdateString("first_name","<string>")
$queryParams.UpdateString("last_name","<string>")
$queryParams.UpdateString("company_name","<string>")
$queryParams.UpdateString("created_at","<string>")
$http.SetRequestHeader("Authorization","{{apiKey}}")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/customers",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "page": "<integer>",
# "pages": "<integer>",
# "limit": "<integer>",
# "total": "<integer>",
# "items": [
# {
# "last_name": "<string>",
# "company_name": "<string>",
# "acquire_options": 7,
# "additional_groups_ids": [
# "<integer>",
# "<integer>"
# ],
# "bank_account": "<string>",
# "bank_account_owner": "<string>",
# "bank_bic": "<string>",
# "bank_code": "<string>",
# "bank_iban": "<string>",
# "bank_name": "<string>",
# "birth_date": "<date>",
# "cash_allowance": "<float>",
# "cash_allowance_days": 7,
# "cash_discount": "<float>",
# "cash_discount_type": "PERCENT",
# "city": "<string>",
# "state": "<string>",
# "country": "<string>",
# "created_at": "<date>",
# "updated_at": "<string>",
# "delivery_title": "<string>",
# "delivery_city": "<string>",
# "delivery_state": "<string>",
# "delivery_company_name": "<string>",
# "delivery_country": "<string>",
# "delivery_first_name": "<string>",
# "delivery_last_name": "<string>",
# "delivery_personal": "<boolean>",
# "delivery_salutation": 0,
# "delivery_street": "<string>",
# "delivery_suffix_1": "<string>",
# "delivery_suffix_2": "<string>",
# "delivery_zip_code": "<string>",
# "display_name": "<string>",
# "emails": [
# "<string>",
# "<string>"
# ],
# "fax": "<string>",
# "first_name": "<string>",
# "grace_period": "<integer>",
# "due_in_days": "<integer>",
# "group_id": "<integer>",
# "id": "<long>",
# "info_1": "<string>",
# "info_2": "<string>",
# "internet": "<string>",
# "login_id": "<long>",
# "mobile": "<string>",
# "note": "<string>",
# "number": "<string>",
# "payment_options": 3,
# "personal": false,
# "phone_1": "<string>",
# "phone_2": "<string>",
# "postbox": "<string>",
# "postbox_city": "<string>",
# "postbox_state": "<string>",
# "postbox_country": "<string>",
# "postbox_zip_code": "<string>",
# "sale_price_level": "SALEPRICE10",
# "salutation": 0,
# "sepa_agreement": "COR1",
# "sepa_agreement_date": "<date>",
# "sepa_mandate_reference": "<string>",
# "since_date": "<date>",
# "street": "<string>",
# "suffix_1": "<string>",
# "suffix_2": "<string>",
# "tax_number": "<string>",
# "court": "<string>",
# "court_registry_number": "<string>",
# "tax_options": "sStfr",
# "title": "<string>",
# "archived": "<boolean>",
# "vat_identifier": "<string>",
# "zip_code": "<string>",
# "document_pdf_type": "default",
# "buyer_reference": "<string>",
# "foreign_supplier_number": "<string>"
# },
# {
# "last_name": "<string>",
# "company_name": "<string>",
# "acquire_options": 7,
# "additional_groups_ids": [
# "<integer>",
# "<integer>"
# ],
# "bank_account": "<string>",
# "bank_account_owner": "<string>",
# "bank_bic": "<string>",
# "bank_code": "<string>",
# "bank_iban": "<string>",
# "bank_name": "<string>",
# "birth_date": "<date>",
# "cash_allowance": "<float>",
# "cash_allowance_days": 7,
# "cash_discount": "<float>",
# "cash_discount_type": "PERCENT",
# "city": "<string>",
# "state": "<string>",
# "country": "<string>",
# "created_at": "<date>",
# "updated_at": "<string>",
# "delivery_title": "<string>",
# "delivery_city": "<string>",
# "delivery_state": "<string>",
# "delivery_company_name": "<string>",
# "delivery_country": "<string>",
# "delivery_first_name": "<string>",
# "delivery_last_name": "<string>",
# "delivery_personal": "<boolean>",
# "delivery_salutation": 0,
# "delivery_street": "<string>",
# "delivery_suffix_1": "<string>",
# "delivery_suffix_2": "<string>",
# "delivery_zip_code": "<string>",
# "display_name": "<string>",
# "emails": [
# "<string>",
# "<string>"
# ],
# "fax": "<string>",
# "first_name": "<string>",
# "grace_period": "<integer>",
# "due_in_days": "<integer>",
# "group_id": "<integer>",
# "id": "<long>",
# "info_1": "<string>",
# "info_2": "<string>",
# "internet": "<string>",
# "login_id": "<long>",
# "mobile": "<string>",
# "note": "<string>",
# "number": "<string>",
# "payment_options": 3,
# "personal": false,
# "phone_1": "<string>",
# "phone_2": "<string>",
# "postbox": "<string>",
# "postbox_city": "<string>",
# "postbox_state": "<string>",
# "postbox_country": "<string>",
# "postbox_zip_code": "<string>",
# "sale_price_level": "SALEPRICE6",
# "salutation": 0,
# "sepa_agreement": "NULL",
# "sepa_agreement_date": "<date>",
# "sepa_mandate_reference": "<string>",
# "since_date": "<date>",
# "street": "<string>",
# "suffix_1": "<string>",
# "suffix_2": "<string>",
# "tax_number": "<string>",
# "court": "<string>",
# "court_registry_number": "<string>",
# "tax_options": "nStb",
# "title": "<string>",
# "archived": "<boolean>",
# "vat_identifier": "<string>",
# "zip_code": "<string>",
# "document_pdf_type": "default",
# "buyer_reference": "<string>",
# "foreign_supplier_number": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$page = $jResp.StringOf("page")
$pages = $jResp.StringOf("pages")
$limit = $jResp.StringOf("limit")
$total = $jResp.StringOf("total")
$i = 0
$count_i = $jResp.SizeOfArray("items")
while ($i -lt $count_i) {
$jResp.I = $i
$last_name = $jResp.StringOf("items[i].last_name")
$company_name = $jResp.StringOf("items[i].company_name")
$acquire_options = $jResp.IntOf("items[i].acquire_options")
$bank_account = $jResp.StringOf("items[i].bank_account")
$bank_account_owner = $jResp.StringOf("items[i].bank_account_owner")
$bank_bic = $jResp.StringOf("items[i].bank_bic")
$bank_code = $jResp.StringOf("items[i].bank_code")
$bank_iban = $jResp.StringOf("items[i].bank_iban")
$bank_name = $jResp.StringOf("items[i].bank_name")
$birth_date = $jResp.StringOf("items[i].birth_date")
$cash_allowance = $jResp.StringOf("items[i].cash_allowance")
$cash_allowance_days = $jResp.IntOf("items[i].cash_allowance_days")
$cash_discount = $jResp.StringOf("items[i].cash_discount")
$cash_discount_type = $jResp.StringOf("items[i].cash_discount_type")
$city = $jResp.StringOf("items[i].city")
$state = $jResp.StringOf("items[i].state")
$country = $jResp.StringOf("items[i].country")
$created_at = $jResp.StringOf("items[i].created_at")
$updated_at = $jResp.StringOf("items[i].updated_at")
$delivery_title = $jResp.StringOf("items[i].delivery_title")
$delivery_city = $jResp.StringOf("items[i].delivery_city")
$delivery_state = $jResp.StringOf("items[i].delivery_state")
$delivery_company_name = $jResp.StringOf("items[i].delivery_company_name")
$delivery_country = $jResp.StringOf("items[i].delivery_country")
$delivery_first_name = $jResp.StringOf("items[i].delivery_first_name")
$delivery_last_name = $jResp.StringOf("items[i].delivery_last_name")
$delivery_personal = $jResp.StringOf("items[i].delivery_personal")
$delivery_salutation = $jResp.IntOf("items[i].delivery_salutation")
$delivery_street = $jResp.StringOf("items[i].delivery_street")
$delivery_suffix_1 = $jResp.StringOf("items[i].delivery_suffix_1")
$delivery_suffix_2 = $jResp.StringOf("items[i].delivery_suffix_2")
$delivery_zip_code = $jResp.StringOf("items[i].delivery_zip_code")
$display_name = $jResp.StringOf("items[i].display_name")
$fax = $jResp.StringOf("items[i].fax")
$first_name = $jResp.StringOf("items[i].first_name")
$grace_period = $jResp.StringOf("items[i].grace_period")
$due_in_days = $jResp.StringOf("items[i].due_in_days")
$group_id = $jResp.StringOf("items[i].group_id")
$id = $jResp.StringOf("items[i].id")
$info_1 = $jResp.StringOf("items[i].info_1")
$info_2 = $jResp.StringOf("items[i].info_2")
$internet = $jResp.StringOf("items[i].internet")
$login_id = $jResp.StringOf("items[i].login_id")
$mobile = $jResp.StringOf("items[i].mobile")
$note = $jResp.StringOf("items[i].note")
$v_number = $jResp.StringOf("items[i].number")
$payment_options = $jResp.IntOf("items[i].payment_options")
$personal = $jResp.BoolOf("items[i].personal")
$phone_1 = $jResp.StringOf("items[i].phone_1")
$phone_2 = $jResp.StringOf("items[i].phone_2")
$postbox = $jResp.StringOf("items[i].postbox")
$postbox_city = $jResp.StringOf("items[i].postbox_city")
$postbox_state = $jResp.StringOf("items[i].postbox_state")
$postbox_country = $jResp.StringOf("items[i].postbox_country")
$postbox_zip_code = $jResp.StringOf("items[i].postbox_zip_code")
$sale_price_level = $jResp.StringOf("items[i].sale_price_level")
$salutation = $jResp.IntOf("items[i].salutation")
$sepa_agreement = $jResp.StringOf("items[i].sepa_agreement")
$sepa_agreement_date = $jResp.StringOf("items[i].sepa_agreement_date")
$sepa_mandate_reference = $jResp.StringOf("items[i].sepa_mandate_reference")
$since_date = $jResp.StringOf("items[i].since_date")
$street = $jResp.StringOf("items[i].street")
$suffix_1 = $jResp.StringOf("items[i].suffix_1")
$suffix_2 = $jResp.StringOf("items[i].suffix_2")
$tax_number = $jResp.StringOf("items[i].tax_number")
$court = $jResp.StringOf("items[i].court")
$court_registry_number = $jResp.StringOf("items[i].court_registry_number")
$tax_options = $jResp.StringOf("items[i].tax_options")
$title = $jResp.StringOf("items[i].title")
$archived = $jResp.StringOf("items[i].archived")
$vat_identifier = $jResp.StringOf("items[i].vat_identifier")
$zip_code = $jResp.StringOf("items[i].zip_code")
$document_pdf_type = $jResp.StringOf("items[i].document_pdf_type")
$buyer_reference = $jResp.StringOf("items[i].buyer_reference")
$foreign_supplier_number = $jResp.StringOf("items[i].foreign_supplier_number")
$j = 0
$count_j = $jResp.SizeOfArray("items[i].additional_groups_ids")
while ($j -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("items[i].additional_groups_ids[j]")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("items[i].emails")
while ($j -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("items[i].emails[j]")
$j = $j + 1
}
$i = $i + 1
}
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "group_id=%3Cstring%3E"
-d "additional_group_id=%3Cstring%3E"
-d "number=%3Cstring%3E"
-d "country=%3Cstring%3E"
-d "zip_code=%3Cstring%3E"
-d "emails=%3Cstring%3E"
-d "first_name=%3Cstring%3E"
-d "last_name=%3Cstring%3E"
-d "company_name=%3Cstring%3E"
-d "created_at=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/customers
Postman Collection Item JSON
{
"name": "Fetch customers list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\n \"additional_groups_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"bank_account\": \"<string>\",\n \"bank_account_owner\": \"<string>\",\n \"bank_bic\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"birth_date\": \"<date>\",\n \"cash_allowance\": \"<float>\",\n \"cash_allowance_days\": 7,\n \"cash_discount\": \"<float>\",\n \"cash_discount_type\": \"PERCENT\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"created_at\": \"<date>\",\n \"updated_at\": \"<string>\",\n \"delivery_title\": \"<string>\",\n \"delivery_city\": \"<string>\",\n \"delivery_state\": \"<string>\",\n \"delivery_company_name\": \"<string>\",\n \"delivery_country\": \"<string>\",\n \"delivery_first_name\": \"<string>\",\n \"delivery_last_name\": \"<string>\",\n \"delivery_personal\": \"<boolean>\",\n \"delivery_salutation\": 0,\n \"delivery_street\": \"<string>\",\n \"delivery_suffix_1\": \"<string>\",\n \"delivery_suffix_2\": \"<string>\",\n \"delivery_zip_code\": \"<string>\",\n \"display_name\": \"<string>\",\n \"emails\": [\n \"<string>\",\n \"<string>\"\n ],\n \"fax\": \"<string>\",\n \"first_name\": \"<string>\",\n \"grace_period\": \"<integer>\",\n \"due_in_days\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"info_1\": \"<string>\",\n \"info_2\": \"<string>\",\n \"internet\": \"<string>\",\n \"login_id\": \"<long>\",\n \"mobile\": \"<string>\",\n \"note\": \"<string>\",\n \"number\": \"<string>\",\n \"payment_options\": 3,\n \"personal\": false,\n \"phone_1\": \"<string>\",\n \"phone_2\": \"<string>\",\n \"postbox\": \"<string>\",\n \"postbox_city\": \"<string>\",\n \"postbox_state\": \"<string>\",\n \"postbox_country\": \"<string>\",\n \"postbox_zip_code\": \"<string>\",\n \"sale_price_level\": \"SALEPRICE10\",\n \"salutation\": 0,\n \"sepa_agreement\": \"COR1\",\n \"sepa_agreement_date\": \"<date>\",\n \"sepa_mandate_reference\": \"<string>\",\n \"since_date\": \"<date>\",\n \"street\": \"<string>\",\n \"suffix_1\": \"<string>\",\n \"suffix_2\": \"<string>\",\n \"tax_number\": \"<string>\",\n \"court\": \"<string>\",\n \"court_registry_number\": \"<string>\",\n \"tax_options\": \"sStfr\",\n \"title\": \"<string>\",\n \"archived\": \"<boolean>\",\n \"vat_identifier\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"document_pdf_type\": \"default\",\n \"buyer_reference\": \"<string>\",\n \"foreign_supplier_number\": \"<string>\"\n },\n {\n \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\n \"additional_groups_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"bank_account\": \"<string>\",\n \"bank_account_owner\": \"<string>\",\n \"bank_bic\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_iban\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"birth_date\": \"<date>\",\n \"cash_allowance\": \"<float>\",\n \"cash_allowance_days\": 7,\n \"cash_discount\": \"<float>\",\n \"cash_discount_type\": \"PERCENT\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"created_at\": \"<date>\",\n \"updated_at\": \"<string>\",\n \"delivery_title\": \"<string>\",\n \"delivery_city\": \"<string>\",\n \"delivery_state\": \"<string>\",\n \"delivery_company_name\": \"<string>\",\n \"delivery_country\": \"<string>\",\n \"delivery_first_name\": \"<string>\",\n \"delivery_last_name\": \"<string>\",\n \"delivery_personal\": \"<boolean>\",\n \"delivery_salutation\": 0,\n \"delivery_street\": \"<string>\",\n \"delivery_suffix_1\": \"<string>\",\n \"delivery_suffix_2\": \"<string>\",\n \"delivery_zip_code\": \"<string>\",\n \"display_name\": \"<string>\",\n \"emails\": [\n \"<string>\",\n \"<string>\"\n ],\n \"fax\": \"<string>\",\n \"first_name\": \"<string>\",\n \"grace_period\": \"<integer>\",\n \"due_in_days\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"info_1\": \"<string>\",\n \"info_2\": \"<string>\",\n \"internet\": \"<string>\",\n \"login_id\": \"<long>\",\n \"mobile\": \"<string>\",\n \"note\": \"<string>\",\n \"number\": \"<string>\",\n \"payment_options\": 3,\n \"personal\": false,\n \"phone_1\": \"<string>\",\n \"phone_2\": \"<string>\",\n \"postbox\": \"<string>\",\n \"postbox_city\": \"<string>\",\n \"postbox_state\": \"<string>\",\n \"postbox_country\": \"<string>\",\n \"postbox_zip_code\": \"<string>\",\n \"sale_price_level\": \"SALEPRICE6\",\n \"salutation\": 0,\n \"sepa_agreement\": \"NULL\",\n \"sepa_agreement_date\": \"<date>\",\n \"sepa_mandate_reference\": \"<string>\",\n \"since_date\": \"<date>\",\n \"street\": \"<string>\",\n \"suffix_1\": \"<string>\",\n \"suffix_2\": \"<string>\",\n \"tax_number\": \"<string>\",\n \"court\": \"<string>\",\n \"court_registry_number\": \"<string>\",\n \"tax_options\": \"nStb\",\n \"title\": \"<string>\",\n \"archived\": \"<boolean>\",\n \"vat_identifier\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"document_pdf_type\": \"default\",\n \"buyer_reference\": \"<string>\",\n \"foreign_supplier_number\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
