List statuses

GET/statuses

Retrieves all statuses (system and custom), optionally filtered by project.

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK
HTTP

import { createConfiguration, StatusesApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new StatusesApi(config);

const result = await api.getStatuses({
  "project": 123
});
console.log(result);

curl --request GET \
  "https://api.testcollab.io/statuses?token=$TESTCOLLAB_TOKEN&project=123"

Parameters

Name	Location	Type	Required	Description
`project`	query	integer	Yes	ID of the project to filter statuses for.
`isActive`	query	boolean	No	Filter statuses by active state.
`_limit`	query	integer	No	—
`_start`	query	integer	No	—
`_sort`	query	string	No	—

Response

200 — A list of statuses.

Field	Type	Required	Description
`[].id`	integer	Yes	Unique identifier for the status
`[].name`	string	Yes	Name of the status
`[].system_name`	string	Yes	System name of the status, used for internal references
`[].description`	string	No	Optional description of the status
`[].priority`	integer	Yes	Priority order of the status (lower number = higher priority)
`[].is_system_field`	boolean	Yes	Whether this is a system-defined status that cannot be deleted
`[].is_active`	boolean	Yes	Whether this status is active and available for use
`[].color`	string	No	Color code associated with this status
`[].ignore_result`	boolean	No	Whether to ignore this result in calculations and reports
`[].enable_report_bug`	boolean	No	Whether to enable the option to report a bug for this status
`[].created_at`	string	No	Date and time when the status was created
`[].updated_at`	string	No	Date and time when the status was last updated

[]

Errors

Status	Meaning
`400`	Bad request - Missing or invalid project ID
`401`	Unauthorized - Authentication required
`403`	Forbidden - User does not have access

List statuses

Example

Parameters

Response

Errors

Next steps