Get Custom Field By ID

Request

Retrieves the details of a custom field using its unique custom field ID.
Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings

Security

bearerAuth

Path

customFieldIdstringrequired

The unique identifier of the custom field to retrieve.

Example:mMa0VjWvqbk8

curl -i -X GET \
  https://api-sandbox.sendpro360.pitneybowes.com/platformapis/api/v1/customfields/mMa0VjWvqbk8 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Requested Custom Field has been retrived successfully.

Bodyapplication/json

One of:

customFieldIdstring

A unique identifier assigned to the custom field.

Example:"mMa0VjWvqbk8"

namestring

The name of the custom field used for identification.

Example:"Shelf#"

customFieldTypestring

Specifies the type of custom field.

Enum:"TEXT""RADIO""CHECKBOX"

Example:"CHECKBOX"

defaultValuestring

The default value assigned to the custom field if no input is provided.

Example:"top"

statusstring

Current status of Custom field.

Enum:"ACTIVE""INACTIVE"

Example:"ACTIVE"

archivedboolean

If the custom field has been deleted or archived.

Example:false

valuesstring or Array of strings

One of:

Single value for the custom field.

string

assignPageFormArray of strings

A list of pages where the custom field is applied or assigned.

Example:

[
  "Receive, Edit, Deliver, Pouch"
]

Response

{
  "customFieldId": "mMa0VjWvqbk8",
  "name": "Shelf#",
  "customFieldType": "CHECKBOX",
  "defaultValue": "top",
  "status": "ACTIVE",
  "archived": false,
  "values": "Male",
  "assignPageForm": [
    "Receive, Edit, Deliver, Pouch"
  ]
}