Skip to content
Hyperproof API
/
/
Task Statuses API

Task Statuses API (1.0)

Provides access to the task status values that are part of a Hyperproof organization.

Download OpenAPI description
taskstatuses.openapi.json
taskstatuses.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/task-statuses/taskstatuses.openapi
Hyperproof US
https://api.hyperproof.app/v1/taskstatuses
Hyperproof Gov
https://api.hyperproofgov.app/v1/taskstatuses
Hyperproof EU
https://api.hyperproof.eu/v1/taskstatuses

Get Task Statuses

Request

GET /

Description

Retrieves all task statuses defined within an organization, including their names, descriptions, and usage details.

Security
oauth2
curl -i -X GET \
  https://developer.hyperproof.app/_mock/hyperproof-api/task-statuses/taskstatuses.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier for the task status.

Example: "ba50096d-bbfa-47af-94a7-092b0984cf35"
orgIdstring(uuid)

The unique identifier for the organization.

Example: "4c05da3f-f076-461c-8105-80a07a42ab7f"
namestring

The user-facing label of the task status.

Example: "Closed"
typestring

The type of the task status.

Enum"notStarted""inProgress""submitted""closed""cancelled"
Example: "closed"
sortOrderinteger

The order in which the task status appears in lists.

Example: 4
]
Response
application/json
[
  {
    "id": "ba50096d-bbfa-47af-94a7-092b0984cf35",
    "orgId": "4c05da3f-f076-461c-8105-80a07a42ab7f",
    "name": "Closed",
    "type": "closed",
    "sortOrder": 4
  }
]
® 2026 Hyperproof All Rights Reserved.