ListIncidentTeams
Retrieve all incident teams for your organization, with optional inclusion of related users. Filter teams by name and manage pagination for efficient data handling.
Instructions
Get all incident teams 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 teams.
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 teams by name.
Responses:
- 200 (Success): OK
- Content-Type:
application/json
- Response Properties:
- data: An array of incident teams.
- included: Included related resources which the user requested.
- Example:
- Content-Type:
- 400: Bad Request
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 401: Unauthorized
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 403: Forbidden
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 404: Not Found
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 429: Too many requests
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
Input Schema
Name | Required | Description | Default |
---|---|---|---|
filter | No | A search query that filters teams 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. |