v1
latestOpenAPI 3.1.02026-08-04147764567.0 KBforms
Get request fields applicable (visible) to current user
get/api/v1/forms/requests
Query parameters
request_form_type'REQUEST' | 'QUESTION_REQUEST' | 'INCIDENT_REQUEST' | 'SERVICE_REQUEST' | 'PROBLEM_REQUEST'
request_type'REQUEST' | 'INCIDENT' | 'SERVICE_REQUEST' | 'PROBLEM' | 'CHANGE' | 'MAJOR_INCIDENT'
supported_objects'REQUEST' | 'SERVICE_REQUEST' | 'INCIDENT' | 'PROBLEM' | 'CHANGE'
The supported object type. Takes precedence over request_type if both are provided.
workspace_idinteger
The workspace id
request_idstring
The request display ID
service_item_idsinteger[]
The service item ids if service request is being created
catalog_item_idsinteger[]
The catalogue item fields if catalogue request is being created, we will depreciate(service_item_ids) this soon.
channel_type'SLACK' | 'MS_TEAMS' | 'EMAIL' | 'ATOMICINBOX' | 'UNIVERSAL_AGENT'
channel_idstring
view'HOME' | 'WORKFLOW' | 'JOURNEY' | 'LIST' | 'INSIGHTS' | 'CUSTOM_SLA' | 'ASSET_LIST' | 'RELATIONSHIP_ATTRIBUTE' | 'SCHEDULE_WORKFLOW' | 'SEARCH' | 'NOTIFICATIONS' | 'ASSET_RELATIONSHIPS' | 'USER_SEGMENTS' | 'MULTI_SOURCE_SYNC' | 'MAJOR_INCIDENT_CREATE' | 'APPROVERS'
status_valuestring
requested_forinteger
User id the request is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.
Headers
X-Api-Keystring required
X-Workspace-Idstring
Response
Successful response
FormsGetapiV1FormsRequestsResponse200 required
Empty response body