Back to Aligni.com

Retrieve the list of all contacts.

Examples

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

# 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/contact?page=1&per_page=25

# response
<?xml version="1.0" encoding="UTF-8"?>
<contacts>
  <contact>
    <id>4</id>
    <first_name>Jim</first_name>
    <last_name>Milspec</last_name>
    <email>jim@milspec.notreal</email>
    <created_at>2016-06-28T03:59:57-05:00</created_at>
    <updated_at>2016-06-28T03:59:57-05:00</updated_at>
  </contact>
  ...
</contacts>

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