Show Many Ticket Forms
GET {{baseUrl}}/api/v2/ticket_forms/show_many?ids=<string>&active=<boolean>&end_user_visible=<boolean>&fallback_to_default=<boolean>&associated_to_brand=<boolean>
Takes an ids query parameter that accepts a comma-separated list of up to 100 ticket form ids. This endpoint is used primarily by the mobile SDK and the Web Widget.
Allowed For
- Anyone
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
ids | string | (Required) IDs of the ticket forms to be shown | |
active | string | true returns active ticket forms; false returns inactive ticket forms. If not present, returns both | |
end_user_visible | string | true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both | |
fallback_to_default | string | true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms | |
associated_to_brand | string | true returns the ticket forms of the brand specified by the url's subdomain |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"ticket_forms":[{"active":true,"agent_conditions":[{"child_fields":[{"id":44,"is_required":false,"required_on_statuses":{"statuses":["new","open","pending","hold"],"type":"SOME_STATUSES"}},{"id":32,"is_required":true,"required_on_statuses":{"statuses":["solved"],"type":"SOME_STATUSES"}}],"parent_field_id":5,"value":"matching_value_1"},{"child_fields":[{"id":44,"is_required":true,"required_on_statuses":{"type":"ALL_STATUSES"}},{"id":32,"is_required":false,"required_on_statuses":{"type":"NO_STATUSES"}}],"parent_field_id":32,"value":"matching_value_2"}],"created_at":"2012-04-02T22:55:29Z","default":true,"display_name":"Snowboard Damage","end_user_conditions":[{"child_fields":[{"id":32,"is_required":true}],"parent_field_id":5,"value":"matching_value_1"},{"child_fields":[{"id":44,"is_required":false}],"parent_field_id":32,"value":"matching_value_2"}],"end_user_visible":true,"id":47,"in_all_brands":false,"name":"Snowboard Problem","position":9999,"raw_display_name":"{{dc.my_display_name}}","raw_name":"Snowboard Problem","restricted_brand_ids":[1,4,6,12,34],"ticket_field_ids":[2,4,5,32,44],"updated_at":"2012-04-02T22:55:29Z","url":"https://company.zendesk.com/api/v2/ticket_forms/47.json"}]}