ListIncidentServices
Retrieve and filter incident services for your organization using query parameters like page size, offset, and name filters. Optionally include related users or attachments in the response.
Instructions
Get all incident services uploaded for the requesting user's organization. If the include[users] query parameter is provided, the included attribute will contain the users related to these incident services.
Query Parameters:
include: Specifies which types of related objects should be included in the response.
page[size]: Size for a given page. The maximum allowed value is 100.
page[offset]: Specific offset to use as the beginning of the returned page.
filter: A search query that filters services by name.
Responses:
200 (Success): OK
Content-Type:
application/jsonResponse Properties:
data: An array of incident services.
included: Included related resources which the user requested.
Example:
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "services"
}
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}400: Bad Request
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}401: Unauthorized
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}403: Forbidden
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}404: Not Found
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}429: Too many requests
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | A search query that filters services by name. | |
| include | No | Object related to an incident. | |
| page[offset] | No | Specific offset to use as the beginning of the returned page. | |
| page[size] | No | Size for a given page. The maximum allowed value is 100. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | An array of incident services. | |
| meta | No | ||
| included | No | Included related resources which the user requested. |