ProTextingdevelopers
API REFERENCEv1

List Custom Field Values

GEThttps://api2.protexting.com/v1/custom-contact-fields-entry/index
⌘

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

Response parameters:

ParameterDescription
Id Custom Field Value Id, int
CustomFieldId Custom Field Id, int
PhoneNumberId Contact Id, int
Entry Custom field value, string, max 255 symbols
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-entry/index?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \  --header 'Accept: application/json'
Server-side exampleJSON · HTTPS

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-entry/?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-Reset

Example Response Body:

JSON response example
[
    {
        "Id": 1,
        "CustomFieldId": 1,        "PhoneNumberId": 1,        "Entry":"[email protected]"
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:21:29",
    },
    {
        "Id": 2,
        "CustomFieldId": 2,        "PhoneNumberId": 2,        "Entry": "1980",        "DateCreated": "2016-10-21 15:10:36",        "DateUpdated": "2016-10-21 15:10:36"
    }
]
XML response example
<response>   <item>      <Id>1</Id>      <CustomFieldId>1</CustomFieldId>      <PhoneNumberId>1</PhoneNumberId>      <Entry>[email protected]</Entry>      <DateCreated>2015-01-20 10:21:29</DateCreated>      <DateUpdated>2015-01-20 10:21:29</DateUpdated>   </item>   <item>      <Id>2</Id>      <CustomFieldId>2</CustomFieldId>      <PhoneNumberId>2</PhoneNumberId>      <Entry>1980</Entry>      <DateCreated>2015-01-20 10:21:29</DateCreated>      <DateUpdated>2015-01-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 »

← PreviousList Custom Field ValuesNext →View Custom Field Value

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