Skip to main content
GET
/
api
/
v1
/
assets
ListAssets
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/assets \
  --header 'Authorization: Bearer <token>'
{
  "assets": [
    {
      "assetId": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "modifiedByUserId": "<string>",
      "tags": [
        "<string>"
      ],
      "metadata": [
        {
          "key": {
            "name": "<string>",
            "type": "METADATA_KEY_TYPE_UNSPECIFIED",
            "archivedDate": "2023-11-07T05:31:56Z"
          },
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true,
          "archivedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "archivedDate": "2023-11-07T05:31:56Z",
      "isArchived": true
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
integer

The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListAssets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssets must match the call that provided the page token.

​
filter
string

A Common Expression Language (CEL) filter string. Available fields to filter by are asset_id, created_by_user_id, modified_by_user_id, created_date, modified_date, name, tag_id, tag_name, is_archived, and metadata. Metadata can be used in filters by using metadata.{metadata_key_name} as the field name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

​
orderBy
string

How to order the retrieved assets. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date and modified_date. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

A successful response.

The result of a call to AssetService_ListAssets.

​
assets
object[]
​
nextPageToken
string