Custom Field API
List Custom Field Options
List the available custom field definitions for a team and ticket type. Returns field definitions with empty values. Use this to discover field keys before setting values on tickets.
get/v2/teams/{team_id}/custom-field-options
Request
- Base URLhttps://public.api.serval.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
team_idstring required
The ID of the team to list custom field options for.
Query parameters
ticketType'TICKET_TYPE_UNSPECIFIED' | 'TICKET_TYPE_REQUEST' | 'TICKET_TYPE_TASK' | 'TICKET_TYPE_MAJOR_INCIDENT' | 'TICKET_TYPE_CONVERSATION' | 'TICKET_TYPE_JOURNEY' | 'TICKET_TYPE_JOURNEY_CONVERSATION' | 'TICKET_TYPE_INCIDENT' | 'TICKET_TYPE_CHANGE' | 'TICKET_TYPE_CUSTOM'
The ticket type to list custom field options for.
ticketSubtypestring
Required for CHANGE tickets — each subtype (normal, standard, emergency, custom) has its own field schema. Omit for non-change types.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.