List Custom Fields


URL:

https://api2.protexting.com/v1/custom-contact-fields/index?access_token=your_access_token


Method:

GET

Response parameters:

Parameter Description
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.
 Value  Custom field entries, array

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/custom-contact-fields/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-Length: 1122
Content-Type: application/json; charset=UTF-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/custom-contact-fields/?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:

[
    {
        "Id": 1,
        "Name": "age",
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:21:29",
        "Value":
        [
            {
                "ValueId": 1,
                "Entry": "23",
                "PhoneNumberId": 1,
                "DateCreated": "2015-02-20 10:21:29",
                "DateUpdated": "2015-02-20 10:21:29",
            },
            {
                "ValueId": 2,
                "Entry": "27",
                "PhoneNumberId": 2,
                "DateCreated": "2015-03-20 10:21:29",
                "DateUpdated": "2015-03-20 10:21:29",
            },
        ]
    },
    {
        "Id": 2,
        "Name": "gender",
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:21:29",
        "Value":[]
    }
]
<response>
<item>
<Id>1</Id>
<Name>age</Name>
<DateCreated>2015-01-20 10:21:29</DateCreated>
<DateUpdated>2015-01-20 10:21:29</DateUpdated>
<Value>
<item>
<ValueId>1</ValueId>
<Entry>23</Entry>
<PhoneNumberId>1</PhoneNumberId>
<DateCreated>2015-02-20 10:21:29</DateCreated>
<DateUpdated>2015-02-20 10:21:29</DateUpdated>
</item>
<item>
<ValueId>2</ValueId>
<Entry>27</Entry>
<PhoneNumberId>2</PhoneNumberId>
<DateCreated>2015-03-20 10:21:29</DateCreated>
<DateUpdated>2015-03-20 10:21:29</DateUpdated>
</item>
</Value>
</item>
<item>
<Id>2</Id>
<Name>gender</Name>
<DateCreated>2015-01-20 10:21:29</DateCreated>
<DateUpdated>2015-01-20 10:21:29</DateUpdated>
<Value/>
</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 »