ProTextingdevelopers
API REFERENCEv1

View Custom Fields

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

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

Request parameters:

ParameterDescription
Id Custom Field Id

Response parameters:

ParameterDescription
Id Custom Field Id
Name Custom field name, string, characters count between 3 and 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/view?id=1&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: 272 Content-Type: application/xml; charset=utf-8 Keep-Alive: timeout=5, max=100 Pragma: no-cache 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
{
        "Id": 1,
        "Name": "age",
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:21:29"
    }
XML response example
<response>   <item>      <Id>1</Id>      <Name>age</Name>      <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 FieldsNext →Create Custom Field

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