Parts

List Parts

Lists a collection of parts.

GET
/parts.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

created_by?array<string>

Filters for parts 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

enhancement.accounts?array<string>

Filters for enhancement by its accounts.

enhancement.actual_close_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
enhancement.actual_close_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
enhancement.actual_start_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
enhancement.actual_start_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
enhancement.opportunities?array<string>

Filters for enhancement by its opportunities.

enhancement.rev_score_tier?array<enhancement-rev-score-tier>

Filters for enhancement by its rev score tier.

enhancement.stage_v2?array<string>

List of IDs of the custom stages which will be used for filtering.

enhancement.state_v2?array<string>

Filters for part with any of the provided custom states.

enhancement.target_close_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
enhancement.target_close_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
enhancement.target_start_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
enhancement.target_start_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
enhancement.tickets?array<string>

Filters for enhancement by its tickets.

limit?integer

The maximum number of parts 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 parts modified by any of these users.

name?array<string>

Filters for parts of the provided name(s).

owned_by?array<string>

Filters for parts owned by any of these users.

parent_part.level?integer

Number of levels to fetch the part hierarchy up to.

Formatint32
Range1 <= value
parent_part.parts?array<string>

Part IDs to fetch the hierarchy for. Required if any parent_part.* fields are provided.

Items1 <= items
sort_by?array<string>

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

subtype?array<string>

Filters for subtypes.

tags?array<string>

Filters for part with any of the provided tags.

type?array<part-type>

Filters for parts of the provided type(s).

Response Body

curl -X GET "https://api.devrev.ai/parts.list?created_by=DEVU-12345&cursor=string&custom_fields=&enhancement.accounts=ACC-12345&enhancement.actual_close_date.after=2023-01-01T12%3A00%3A00.000Z&enhancement.actual_close_date.before=2023-01-01T12%3A00%3A00.000Z&enhancement.actual_start_date.after=2023-01-01T12%3A00%3A00.000Z&enhancement.actual_start_date.before=2023-01-01T12%3A00%3A00.000Z&enhancement.opportunities=OPP-12345&enhancement.rev_score_tier=high&enhancement.stage_v2=string&enhancement.state_v2=string&enhancement.target_close_date.after=2023-01-01T12%3A00%3A00.000Z&enhancement.target_close_date.before=2023-01-01T12%3A00%3A00.000Z&enhancement.target_start_date.after=2023-01-01T12%3A00%3A00.000Z&enhancement.target_start_date.before=2023-01-01T12%3A00%3A00.000Z&enhancement.tickets=string&limit=0&mode=after&modified_by=DEVU-12345&name=string&owned_by=DEVU-12345&parent_part.level=1&parent_part.parts=PROD-12345&sort_by=string&subtype=string&tags=TAG-12345&type=capability"
{
  "next_cursor": "string",
  "parts": [
    {
      "type": "capability",
      "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",
      "artifacts": [
        {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        }
      ],
      "custom_fields": {},
      "custom_schema_fragments": [
        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
      ],
      "description": "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"
        }
      ],
      "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"
        }
      ]
    }
  ],
  "prev_cursor": "string"
}
{
  "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"
}