API DocsRESTAsset service

ListAssets

Retrieves assets using an optional filter.

GET
/api/v1/assets

Query Parameters

pageSizeinteger

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.

Format: "int64"

pageTokenstring

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.

filterstring

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, and 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.

orderBystring

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

curl -X GET "<API_URL>/api/v1/assets?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "assets": [
    {
      "assetId": "string",
      "name": "string",
      "organizationId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "modifiedByUserId": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Previous

GetAsset GET

Next

UpdateAsset PATCH