Back to Aligni.com

Retrieve the list of all customers.

Examples

# request
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/customer

# Pagination
# The pagination information is included in the response X-Pagination
# header.
# {"total_entries":0,"total_pages":0,"per_page":25,"current_page":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null,"out_of_range":true}
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/customer?page=1&per_page=25

# response
<?xml version="1.0" encoding="UTF-8"?>
<customers>
  <customer>
    <id>4</id>
    <name>Markus, Inc.</name>
    <email></email>
    <discount>10.00</discount>
    <tax_identification_number>12-3456789</tax_identification_number>
    <account_number>1234</account_number>
    <credit_terms></credit_terms>
    <credit_limit></credit_limit>
    <payment_method></payment_method>
    <contacts>
      <contact>
        <id>1</id>
      <contact>
    </contacts>
  </customer>
  ...
</customers>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
page
optional

Fetch requested page.


Value: Must be a Integer
per_page
optional

Fetch a specific number of entries per page.


Value: Must be a Integer