Works

List Works

Lists a collection of work items.

GET
/works.list
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

applies_to_part?array<string>

Filters for work belonging to any of the provided parts.

created_by?array<string>

Filters for work created by any of these users.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
custom_fields?object

Filters for custom fields.

Empty Object

issue.accounts?array<string>

Filters for issues with any of the provided accounts.

issue.priority?array<issue-priority>

Filters for issues with any of the provided priorities.

issue.priority_v2?array<integer>

Filters for issues with any of the provided priority enum ids.

issue.rev_orgs?array<string>

Filters for issues with any of the provided Rev organizations.

issue.sla_summary.stage?array<sla-summary-stage>

Filters for records with any of the provided SLA stages.

issue.sprint?array<string>

Filters for issues with any of the sprint.

issue.subtype?array<string>

Filters for issues with any of the provided subtypes.

limit?integer

The maximum number of works to return. The default is '50'.

Formatint32
mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
modified_by?array<string>

Filters for work modified by any of these users.

opportunity.account?array<string>

Filters for opportunities belonging to any of the provided accounts.

opportunity.contacts?array<string>

Filters for opportunities with any of the provided contacts.

opportunity.forecast_category_v2?array<integer>

Filters for opportunities with any of the provided forecast category enum IDs.

opportunity.subtype?array<string>

Filters for opportunity with any of the provided subtypes.

owned_by?array<string>

Filters for work owned by any of these users.

reported_by?array<string>

Filters for work reported by any of these users.

sort_by?array<string>

Fields to sort the works by and the direction to sort them.

stage.name?array<string>

Filters for records in the provided stage(s) by name.

staged_info.is_staged?boolean

Filters for issues that are staged.

state?array<string>

Filters for work with any of the provided states.

sync_metadata.external_reference?array<string>

Filters for issues with this specific external reference.

sync_metadata.last_sync_in.status?array<sync-metadata-filter-sync-in-filter-status>

Filters for works with selected sync statuses.

sync_metadata.last_sync_in.sync_history?array<string>

Filters for works modified with selected sync history.

sync_metadata.last_sync_in.sync_unit?array<string>

Filters for works modified with selected sync units.

sync_metadata.last_sync_out.status?array<sync-metadata-filter-sync-out-filter-status>

Filters for works with selected sync statuses.

sync_metadata.last_sync_out.sync_history?array<string>

Filters for works modified with selected sync history.

sync_metadata.last_sync_out.sync_unit?array<string>

Filters for works modified with selected sync units.

sync_metadata.origin_system?array<string>

Filters for issues synced from this specific origin system.

tags?array<string>

Filters for work with any of the provided tags.

ticket.brand?array<string>

Filters for tickets that are associated with any of the brands.

ticket.channels?array<ticket-channels>

Filters for tickets with any of the provided channels.

ticket.channels_v2?array<string>

Filters for tickets that are associated with any of the channels.

ticket.group?array<string>

Filters for tickets belonging to specific groups.

ticket.is_frozen?boolean

Filters for frozen tickets.

ticket.is_spam?boolean

Filters for tickets that are spam.

ticket.needs_response?boolean

Filters for tickets that need response.

ticket.rev_org?array<string>

Filters for tickets that are associated with any of the provided Rev organizations.

ticket.severity?array<ticket-severity>

Filters for tickets with any of the provided severities.

ticket.sla_summary.stage?array<sla-summary-stage>

Filters for records with any of the provided SLA stages.

ticket.source_channel?array<string>

Filters for tickets with any of the provided source channels.

ticket.source_channel_v2?array<string>

Filters for tickets that are associated with any of the source channels.

ticket.subtype?array<string>

Filters for tickets with any of the provided subtypes.

type?array<work-type>

Filters for work of the provided types.

Response Body

curl -X GET "https://api.devrev.ai/works.list?applies_to_part=PROD-12345&created_by=DEVU-12345&cursor=string&custom_fields=&issue.accounts=ACC-12345&issue.priority=p0&issue.priority_v2=0&issue.rev_orgs=REV-AbCdEfGh&issue.sla_summary.stage=breached&issue.sprint=string&issue.subtype=string&limit=0&mode=after&modified_by=DEVU-12345&opportunity.account=ACC-12345&opportunity.contacts=string&opportunity.forecast_category_v2=0&opportunity.subtype=string&owned_by=DEVU-12345&reported_by=DEVU-12345&sort_by=string&stage.name=string&staged_info.is_staged=true&state=string&sync_metadata.external_reference=string&sync_metadata.last_sync_in.status=failed&sync_metadata.last_sync_in.sync_history=string&sync_metadata.last_sync_in.sync_unit=string&sync_metadata.last_sync_out.status=failed&sync_metadata.last_sync_out.sync_history=string&sync_metadata.last_sync_out.sync_unit=string&sync_metadata.origin_system=string&tags=TAG-12345&ticket.brand=string&ticket.channels=email&ticket.channels_v2=string&ticket.group=string&ticket.is_frozen=true&ticket.is_spam=true&ticket.needs_response=true&ticket.rev_org=REV-AbCdEfGh&ticket.severity=blocker&ticket.sla_summary.stage=breached&ticket.source_channel=string&ticket.source_channel_v2=string&ticket.subtype=string&type=issue"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "works": [
    {
      "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": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}