Works

Get Work

Gets a work item's information.

GET
/works.get
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

idstring

The work's ID.

Formatid

Response Body

curl -X GET "https://api.devrev.ai/works.get?id=ISS-12345"
{
  "work": {
    "type": "issue",
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "actual_close_date": "2023-01-01T12:00:00.000Z",
    "applies_to_part": {
      "type": "capability",
      "display_id": "string",
      "id": "string",
      "name": "string",
      "owned_by": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ],
      "sync_metadata": {
        "external_reference": "string",
        "origin_system": "string"
      }
    },
    "artifacts": [
      {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      }
    ],
    "body": "string",
    "custom_fields": {},
    "custom_schema_fragments": [
      "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
    ],
    "owned_by": [
      {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      }
    ],
    "reported_by": [
      {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      }
    ],
    "stage": {
      "name": "string",
      "notes": "string",
      "ordinal": 0,
      "stage": {
        "display_id": "string",
        "id": "string",
        "name": "string"
      },
      "state": {
        "display_id": "string",
        "id": "string",
        "is_final": true,
        "name": "string"
      }
    },
    "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
    "subtype": "string",
    "sync_metadata": {
      "external_reference": "string",
      "last_sync_in": {
        "status": "failed",
        "sync_date": "2023-01-01T12:00:00.000Z",
        "sync_unit": {
          "display_id": "string",
          "id": "string",
          "external_system_type": "adaas",
          "is_archived": true,
          "name": "string",
          "sync_run": {
            "mode": "initial",
            "progress": {
              "state": "completed"
            }
          },
          "sync_type": "manual"
        }
      },
      "last_sync_out": {
        "status": "failed",
        "sync_date": "2023-01-01T12:00:00.000Z",
        "sync_unit": {
          "display_id": "string",
          "id": "string",
          "external_system_type": "adaas",
          "is_archived": true,
          "name": "string",
          "sync_run": {
            "mode": "initial",
            "progress": {
              "state": "completed"
            }
          },
          "sync_type": "manual"
        }
      },
      "origin_system": "string"
    },
    "tags": [
      {
        "tag": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "style_new": {
            "color": "string"
          }
        },
        "value": "string"
      }
    ],
    "target_close_date": "2023-01-01T12:00:00.000Z",
    "title": "string",
    "actual_start_date": "2023-01-01T12:00:00.000Z",
    "developed_with": [
      {
        "type": "capability",
        "display_id": "string",
        "id": "string",
        "name": "string",
        "owned_by": [
          {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          }
        ],
        "sync_metadata": {
          "external_reference": "string",
          "origin_system": "string"
        }
      }
    ],
    "estimated_effort": 0.1,
    "priority": "p0",
    "priority_v2": {
      "id": 0,
      "label": "string",
      "ordinal": 0,
      "value": null
    },
    "sla_summary": {
      "closest_to_breach_metric": "string",
      "org_schedule": {
        "display_id": "string",
        "id": "string",
        "name": "string",
        "status": "archived",
        "timezone": "string",
        "valid_until": "2023-01-01T12:00:00.000Z"
      },
      "remaining_time": 0,
      "sla_tracker": {
        "created_by": {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        },
        "created_date": "2023-01-01T12:00:00.000Z",
        "display_id": "string",
        "id": "string",
        "modified_by": {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        },
        "modified_date": "2023-01-01T12:00:00.000Z",
        "applies_to_id": "string",
        "applies_to_type": "conversation",
        "metric_target_summaries": [
          {
            "breached_at": "2023-01-01T12:00:00.000Z",
            "completed_at": "2023-01-01T12:00:00.000Z",
            "completed_in": 0,
            "in_policy": true,
            "is_out_of_schedule": true,
            "metric_definition": {
              "display_id": "string",
              "id": "string",
              "name": "string"
            },
            "next_schedule_transition": "2023-01-01T12:00:00.000Z",
            "org_schedule": {
              "display_id": "string",
              "id": "string",
              "name": "string",
              "status": "archived",
              "timezone": "string",
              "valid_until": "2023-01-01T12:00:00.000Z"
            },
            "remaining_time": 0,
            "stage": "string",
            "status": "string",
            "target_time": "2023-01-01T12:00:00.000Z",
            "warning_target_time": "2023-01-01T12:00:00.000Z"
          }
        ],
        "removed_sla_metric_history": [
          {
            "metric_definition": {
              "display_id": "string",
              "id": "string",
              "name": "string"
            },
            "removed_at": "2023-01-01T12:00:00.000Z",
            "removed_by": {
              "type": "dev_user",
              "display_id": "string",
              "id": "string",
              "display_name": "string",
              "display_picture": {
                "display_id": "string",
                "id": "string",
                "file": {
                  "type": "string",
                  "name": "string",
                  "size": 0
                }
              },
              "email": "string",
              "full_name": "string",
              "state": "active"
            }
          }
        ],
        "sla": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "sla_type": "external",
          "status": "archived"
        },
        "sla_policy_id": "string",
        "stage": "string",
        "status": "string"
      },
      "stage": "breached",
      "target_time": "2023-01-01T12:00:00.000Z"
    },
    "sla_tracker": {
      "display_id": "string",
      "id": "string",
      "applies_to_type": "conversation"
    },
    "sprint": {
      "type": "curated",
      "end_date": "2023-01-01T12:00:00.000Z",
      "id": "string",
      "name": "string",
      "start_date": "2023-01-01T12:00:00.000Z",
      "state": "active"
    },
    "target_start_date": "2023-01-01T12:00:00.000Z"
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}