CustomField

OData end point to get a list of all available custom fields for an object

get/api/customfield

Request

  • Base URL
    https://api.practicepanther.com
  • URL
    https://api.practicepanther.com/api/customfield
  • Auth
    OAuth 2
    Authorization code: /OAuth/Authorize
    Token URL: /OAuth/Token scopes: full

Query parameters

objectType'Account' | 'Project' | 'Contact' | 'User' | 'Address' required

Project/Contact/Account

Response

OK

guidstring uuid
objectType'Account' | 'Project' | 'Contact' | 'User' | 'Address' required

Sets the object type this custom field relates to

valueType'TextBox' | 'Date' | 'DateTime' | 'Number' | 'Currency' | 'TextEditor' | 'DropDownList' | 'Checkbox' | 'Contact' required

Sets the value type for this custom field. Will affect CustomFieldValues

namestring required
isDeletedboolean
isRequiredboolean
isDefaultboolean
dropDownListValuesstring

Comma separated list of values for ValueType 'dropDownList'.

Example response

[
  {
    "guid": "00000000-0000-0000-0000-000000000000"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.