Skip to content

Get#

Get Custom Field by id;

Query#

GET /api/customField/{id}

with:

  • id: id or name of the custom field.

Response#

Status codes#

  • 200: if query is run successfully
  • 401: Authentication error
  • 403: Authorization error

ResponseBody Example#

{
  "id": "~28672",
  "name": "Number of Accounts",
  "reference": "Number of Accounts",
  "description": "Number of accounts leaked",
  "type": "integer",
  "options": [],
  "mandatory": true
}

{
  "type": "AuthenticationError",
  "message": "Authentication failure"
}

{
  "type": "AuthorizationError",
  "message": "Your are not authorized to create custom field, you haven't the permission manageCustomField"
}
Last update: October 13, 2023 07:01:35