Skip to content
developers
Open TestCollab

Get a specific status by ID

GET/statuses/{statusId}

Retrieves details of a specific status by its ID. Project context might be required for authorization.

Example

Section titled “Example”

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

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


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


const result = await api.getStatusById({
  "statusId": 0
});
console.log(result);

Parameters

Section titled “Parameters”
Name Location Type Required Description
statusId path integer Yes ID of the status to retrieve.
project query integer No ID of the project for context (if status is project-specific and needs auth check).

Response

Section titled “Response”

200 — Details of the status.

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
Illustrative response
{
  "id": 123,
  "name": "example",
  "system_name": "example",
  "description": "example",
  "priority": 123,
  "is_system_field": true,
  "is_active": true,
  "color": "example",
  "ignore_result": true
}

Errors

Section titled “Errors”
Status Meaning
401 Unauthorized - Authentication required
403 Forbidden - User does not have access
404 Status not found

Next steps

Section titled “Next steps”