SMsmartsheet
status options

Fetch status option

Retrieves a single status option by its ID.

get/status_options/{status_option_id}

Request

  • Base URL
    https://api.rm.smartsheet.com/api/v1
  • Auth
    API key in header auth

Path parameters

status_option_idinteger required

The ID of the status option.

Response

The requested status option object.

idinteger required

The unique identifier for the status option.

color'blue_bright' | 'blue_dark' | 'green_bright' | 'green_dark' | 'yellow' | 'orange' | 'red' | 'purple' | 'gray' required

The color of the status option.

labelstring required

The label for the status option.

stage'planned' | 'in_progress' | 'done' required

The stage of the status option.

ordernumber required

A float number used for sorting.

created_atstring date-time

The time of creation.

updated_atstring date-time

The time of the last update.

deleted_atstring date-time nullable

The time the status option was deleted.

Example response

{
  "color": "green_bright",
  "label": "On Track",
  "stage": "in_progress",
  "order": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.