Skip to content
Shared APIs
/
/Custom Fields

Custom Fields

APIs for retrieving custom field definitions configured in the platform.

Operations

Get Custom Fields

Request

This operation retrieves the list of custom fields defined on the platform.
Custom fields are additional package fields that can be displayed on PitneyTrack workflow pages.Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings.

Security
bearerAuth
Query
skipinteger

The page number of the results to retrieve. Pagination starts from 0.

Example:skip=0
limitinteger

The number of custom fields to retrieve per page.

Example:limit=25
searchBystring

Search criteria for custom fields.

Example:searchBy=status:ACTIVE, name:customFieldName
querystring

Search by name for custom fields.

Example:query=name:customFieldName
curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/platformapis/api/v1/customfields?skip=0&limit=25&searchBy=status%3AACTIVE%2C%20name%3AcustomFieldName&query=name%3AcustomFieldName' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Custom fields fetched successfully.

Bodyapplication/json
pageInfoobject(PageInfo)
customFieldsArray of objects(CustomField)
Response
{
  "pageInfo": {
    "totalCount": 30,
    "startCount": 1,
    "limit": 20
  },
  "customFields": [
    {
      "customFieldId": "mMa0VjWvqbk8",
      "name": "Shelf#",
      "customFieldType": "CHECKBOX",
      "defaultValue": "top",
      "status": "ACTIVE",
      "archived": false,
      "values": "Male",
      "assignPageForm": [ … ]
    }
  ]
}