Get Custom Fields

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.

SecuritybearerAuth

Request

query Parameters

skip	integer The page number of the results to retrieve. Pagination starts from 0. Example: skip=0
limit	integer The number of custom fields to retrieve per page. Example: limit=25
searchBy	string Search criteria for custom fields. Example: searchBy=status:ACTIVE, name:customFieldName
query	string Search by name for custom fields. Example: query=name:customFieldName

Responses

200

Custom fields fetched successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/customfields

Request samples

Response samples

application/json

{"pageInfo": {"totalCount": 30,
"startCount": 1,
"limit": 20
},
"customFields": [{"customFieldId": "mMa0VjWvqbk8",
"name": "Shelf#",
"customFieldType": "CHECKBOX",
"defaultValue": "top",
"status": "ACTIVE",
"archived": false,
"values": "Male",
"assignPageForm": ["Receive, Edit, Deliver, Pouch"
]
}
]
}