API Reference – Marketing API – Getting Custom Fields

Marketing API Method Documentation

©2009-2017 SocketLabs, Inc., Version 0.1, Last Edit: May 25, 2017

GET /customfields

Synopsis:

Get a list of all custom fields for your server.

Recommended Usage:

This GET method will return the full list of custom fields for your server.  There are no parameters or options for this method, and it will always return the full list of custom fields.

Request Information

HTTP Method:

GET

URL:

https://api.socketlabs.com/marketing/v1/customfields

Response Format Types:

JSON or XML

Example Request:

GET /marketing/v1/customfields HTTP/1.1
Host: api.socketlabs.com
Authorization: Basic XXXXXXXXXXXXXXXXXXXx==
Cache-Control: no-cache

Response Parameters

customFieldNameId
The unique ID for your custom field.
customFieldType
Your custom field’s type.  Currently, custom fields can only be Strings, but other types may be supported in the future.
name
Your custom field’s name.
serverId
Your server’s Id.

Response Examples

Example Response (JSON):

[
 {
 "customFieldNameId": 123,
 "name": "firstName",
 "serverId": 98765,
 "customFieldType": "String"
 },
 {
 "customFieldNameId": 234,
 "name": "lastName",
 "serverId": 98765,
 "customFieldType": "String"
 },
 {
 "customFieldNameId": 345,
 "name": "favoriteColor",
 "serverId": 98765,
 "customFieldType": "String"
 }
]

Customers Who Trust in SocketLabs

You’re in good company when working with SocketLabs. Here are some companies who have also trusted SocketLabs.

Why SocketLabs?

What Our Customers Are Saying!