Overview

Estimates define how work is sized in a project. An estimate represents the scale (categories, points, or time), and estimate points represent the allowed values on work items.

The Estimate Object

Attributes

• name string (required)

  Name of the estimate

• description string

  Description of the estimate

• type string

  Type of estimate. Possible values: categories, points, time

• last_used boolean

  Whether this estimate is the most recently used estimate for the project

• external_id string or null

  External ID from an external system

• external_source string or null

  External source identifier

• created_at, updated_at timestamp

  Timestamps when the estimate was created and last updated

• created_by, updated_by uuid

  IDs of the users who created and last updated the estimate

• project uuid

  Project ID associated with the estimate

• workspace uuid

  Workspace ID associated with the estimate

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T12:10:00Z",
  "name": "Story Points",
  "description": "Standard story point scale",
  "type": "points",
  "last_used": true,
  "external_id": "sp-001",
  "external_source": "jira",
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4"
}

The Estimate Point Object

Attributes

• estimate uuid (required)

  Estimate ID this point belongs to

• key integer

  Numeric key used for ordering and display

• value string (required)

  Display value for the estimate point (max 20 characters)

• description string

  Description of the estimate point

• external_id string or null

  External ID from an external system

• external_source string or null

  External source identifier

• created_at, updated_at timestamp

  Timestamps when the estimate point was created and last updated

• created_by, updated_by uuid

  IDs of the users who created and last updated the estimate point

• project uuid

  Project ID associated with the estimate point

• workspace uuid

  Workspace ID associated with the estimate point

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "created_at": "2024-01-15T10:40:00Z",
  "updated_at": "2024-01-20T12:15:00Z",
  "estimate": "550e8400-e29b-41d4-a716-446655440000",
  "key": 3,
  "value": "3",
  "description": "Small",
  "external_id": "sp-3",
  "external_source": "jira",
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4"
}