List Contacts


URL:

https://api2.protexting.com/v1/contacts/index?access_token=your_access_token


Method:

GET

Response parameters:

Parameter Description
Id Phone number Id
Number Phone number
OptedOut If the contact opted out
OptedOutViaApi If the contact opted out from Contacts API (eligible to opt in via “Undo Opt Out Contacts” only)
FirstName Contact's first name
LastName Contact's last name
BirthDay Contact's birthday
Email Contact's email
Zip Contact's zip
City Contact's city
DateCreated The date when the record was created
DateUpdated The date when the record was updated
GroupIds Group Ids, array of integers, the Ids of the Groups the phone number is added to
CustomFieldIds Custom Field Ids, array of integers, the Ids of the the custom fields the contact has filled

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/contacts/index?access_token=your_access_token"

 

Example Response Headers:

Status Code: 200 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/contacts?access_token=your_access_token&page=1>; 
rel=self Pragma: no-cache Transfer-Encoding: chunked X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 46 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

[
    {
        "Id": 1,
        "Number": "16461234567",
        "OptedOut": 0,
"OptedOutViaApi": 0, "FirstName": "John", "LastName": "Smith", "BirthDay": "0000-00-00", "Email": "", "Zip": "", "City": "", "DateCreated": "2015-01-20 10:21:29", "DateUpdated": "2015-01-20 10:21:29", "GroupIds": [1,2], "CustomFieldIds":[] }, { "Id": 2, "Number": "16461134567", "OptedOut": 0,
"OptedOutViaApi": 0, "FirstName": "Jane", "LastName": "", "BirthDay": "0000-00-00", "Email": "", "Zip": "", "City": "", "DateCreated": "2015-01-20 10:21:30", "DateUpdated": "2015-01-20 10:21:30", "GroupIds": [3], "CustomFieldIds":[] } ... ]
<response>
<item>
<Id>1</Id>
<Number>16461234567</Number>
<OptedOut>0</OptedOut>
  <OptedOutViaApi>0</OptedOutViaApi>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<BirthDay>0000-00-00</BirthDay>
<Email/>
<Zip/>
<City/>
<DateCreated>2015-01-20 10:21:29</DateCreated>
<DateUpdated>2015-01-20 10:21:29</DateUpdated>
<GroupIds>
<item>1</item>
<item>2</item>
</GroupIds>
<CustomFieldIds/>
</item>
<item>
<Id>2</Id>
<Number>16461134567</Number>
<OptedOut>0</OptedOut>
  <OptedOutViaApi>0</OptedOutViaApi>
<FirstName>Jane</FirstName>
<LastName></LastName>
<BirthDay>0000-00-00</BirthDay>
<Email/>
<Zip/>
<City/>
<DateCreated>2015-01-20 10:21:30</DateCreated>
<DateUpdated>2015-01-20 10:21:30</DateUpdated>
<GroupIds>
<item>3</item>
</GroupIds>
<CustomFieldIds/>
</item>
...
</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

Note:

If the contact opted out from Contacts API (eligible to opt in via “Undo Opt Out Contacts”)