API REFERENCEv1

List Contacts

GEThttps://api2.protexting.com/v1/contacts/index

⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

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
CustomFields	Custom Field data

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/contacts/index?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

1Status Code: 200 OK
2Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
3Connection: Keep-Alive
4Content-Type: application/xml; charset=utf-8
5Keep-Alive: timeout=5, max=100
6Link: <https://api2.protexting.com/v1/contacts?access_token=your_access_token&page=1>; 7rel=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:

JSON response example

1[
2    {
3        "Id": 1,
4        "Number": "16461234567",
5        "OptedOut": 0,6        "OptedOutViaApi": 0,
7        "FirstName": "John",
8        "LastName": "Smith",
9        "BirthDay": "0000-00-00",
10        "Email": "",
11        "Zip": "",
12        "City": "",
13        "DateCreated": "2015-01-20 10:21:29",
14        "DateUpdated": "2015-01-20 10:21:29",
15        "GroupIds": [1,2],
16        "CustomFields":[17            {18                "CustomFieldId": 1,19                "CustomFieldName":"Field Test",20                "CustomFieldValueId": 1121                "CustomFieldValue": "Test Value",22             }23         ]
24    },
25    {
26        "Id": 2,
27        "Number": "16461134567",
28        "OptedOut": 0,29        "OptedOutViaApi": 0,
30        "FirstName": "Jane",
31        "LastName": "",
32        "BirthDay": "0000-00-00",
33        "Email": "",
34        "Zip": "",
35        "City": "",
36        "DateCreated": "2015-01-20 10:21:30",
37        "DateUpdated": "2015-01-20 10:21:30",
38        "GroupIds": [3],
39        "CustomFields":[40            {41                "CustomFieldId": 2,42                "CustomFieldName":"Field Test 2",43                "CustomFieldValueId": 1244                "CustomFieldValue": "Test Value 2",45            }46         ]
47    }
48    ...
49]

XML response example

1<response>2   <item>3      <Id>1</Id>4      <Number>16461234567</Number>5      <OptedOut>0</OptedOut>6      <OptedOutViaApi>0</OptedOutViaApi>7      <FirstName>John</FirstName>8      <LastName>Smith</LastName>9      <BirthDay>0000-00-00</BirthDay>10      <Email/>11      <Zip/>12      <City/>13      <DateCreated>2015-01-20 10:21:29</DateCreated>14      <DateUpdated>2015-01-20 10:21:29</DateUpdated>15      <GroupIds>16         <item>1</item>17         <item>2</item>18      </GroupIds>19      <CustomFields>20          <item>21              <CustomFieldId>1</CustomFieldId>22              <CustomFieldName>Field Test</CustomFieldName>23              <CustomFieldValueId>11</CustomFieldValueId>24              <CustomFieldValue>Test Value</CustomFieldValue>25          </item>26       </CustomFields>27   </item>28   <item>29      <Id>2</Id>30      <Number>16461134567</Number>31      <OptedOut>0</OptedOut>32      <OptedOutViaApi>0</OptedOutViaApi>33      <FirstName>Jane</FirstName>34      <LastName></LastName>35      <BirthDay>0000-00-00</BirthDay>36      <Email/>37      <Zip/>38      <City/>39      <DateCreated>2015-01-20 10:21:30</DateCreated>40      <DateUpdated>2015-01-20 10:21:30</DateUpdated>41      <GroupIds>42         <item>3</item>43      </GroupIds>44      <CustomFields>45          <item>46              <CustomFieldId>2</CustomFieldId>47              <CustomFieldName>Field Test 2</CustomFieldName>48              <CustomFieldValueId>12</CustomFieldValueId>49              <CustomFieldValue>Test Value 2</CustomFieldValue>50          </item>51       </CustomFields>52    </item>53 ...54</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”)

← PreviousRemove Keyword Next →View Contact

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.