API REFERENCEv1
List Custom Field Values
GET
https://api2.protexting.com/v1/custom-contact-fields/values⌘
Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →
Request parameters:
* required parameters
| Parameter | Description |
|---|---|
| * id (type: GET) | Custom Field Id |
Response parameters:
| Parameter | Description |
|---|---|
| Id | Integer |
| Entry | String |
| PhoneNumberId | Integer, see here » |
| DateCreated | The date when the record was created, string. |
| DateUpdated | The date when the record was updated, string. |
Example Request:
Request example
# Set PROTEXTING_ACCESS_TOKEN in your environmentcurl --request GET \ "https://api2.protexting.com/v1/custom-contact-fields/values?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \ --header 'Accept: application/json'Example Response Headers:
Response headers example
Status Code: 200 OK Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 Connection: Keep-Alive Content-Length: 1122 Content-Type: application/json; charset=UTF-8 Keep-Alive: timeout=5, max=100 Link: <https://api2.protexting.com/v1/custom-contact-fields/values?access_token=your_access_token&page=1>; rel=self Pragma: no-cache X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 6 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-ResetExample Response Body:
JSON response example
[
{
"Id": 1,
"Entry": "23",
"PhoneNumberId": 100,
"DateCreated": "2015-02-20 10:21:29",
"DateUpdated": "2015-02-20 10:21:29"
},
{
"Id": 2,
"Entry": "25",
"PhoneNumberId": 101,
"DateCreated": "2015-02-20 10:21:29",
"DateUpdated": "2015-02-20 10:21:29"
}
]XML response example
<response> <item> <Id>1</Id> <Entry>23</Entry> <PhoneNumberId>100</PhoneNumberId> <DateCreated>2015-02-20 10:21:29</DateCreated> <DateUpdated>2015-02-20 10:21:29</DateUpdated> </item> <item> <Id>2</Id> <Entry>25</Entry> <PhoneNumberId>101</PhoneNumberId> <DateCreated>2015-02-20 10:21:29</DateCreated> <DateUpdated>2015-02-20 10:21:29</DateUpdated> </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 »
Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.