API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve custom fields

This method allows you to retrieve a specific custom field or all custom fields irrespective of their type. Use the optional query parameter locale to only retrieve the collection of localized fields for a specific locale across all custom fields. If none of the custom fields have a localized field collection for the specified locale, the HTTP status code of 404-Not Found is returned.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

Idinteger

Optional custom field Id. If specified, only the custom field with this Id will be returned. Default value is 0.

Default value
0
localestring

Optional locale. If specified, only custom fields associated with the locale are returned.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences Account Id. A 404 is returned if this value is invalid.

Response

200
Object

Response Attributes

DateTimeFieldsarray

Show child attributes

NumericFieldsarray

Show child attributes

SelectListFieldsarray

Show child attributes

TextFieldsarray

Show child attributes

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
409
Object
The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?