---
title: "Get Incident State"
method: POST
path: "/incident-state/{id}/get-item"
tags: ["Incident State"]
---

# Get Incident State

`POST /incident-state/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/incident-state/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/incident-state/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Incident State by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` IncidentStateSelectSchema: Select schema for IncidentState. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `slug` boolean
    - `description` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean
    - `color` boolean
    - `isCreatedState` boolean
    - `isAcknowledgedState` boolean
    - `isResolvedState` boolean
    - `order` boolean
    - `isArchived` boolean
    - `archivedAt` boolean
    - `archivedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` IncidentState
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `slug` string, required: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]
    - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]
    - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `isCreatedState` boolean: Is it the created state of the incident? Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `isAcknowledgedState` boolean: Is it the acknowledged state of the incident? Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `isResolvedState` boolean: Is it the resolved state of the incident? Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `order` integer: Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `isArchived` boolean, required: Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Incident State], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [Project Owner, Project Admin, Incident Admin, Edit Incident State]
    - `archivedAt` object: When this incident state was archived. Empty while it is not archived. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]
    - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident State], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)