Skip to main content
GET
/
api
/
v1
/
metadata-keys
ListMetadataKeys
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/metadata-keys \
  --header 'Authorization: Bearer <token>'
{
  "metadataKeys": [
    {
      "name": "<string>",
      "type": "METADATA_KEY_TYPE_UNSPECIFIED",
      "archivedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "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 metadata keys to return. The service may return fewer than this value. If unspecified, at most 50 metadata keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

​
pageToken
string

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

​
filter
string

A Common Expression Language (CEL) filter string. Available fields to filter by are: 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 metadata keys. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and name. 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"

Response

A successful response.

The response of a call to MetadataService_ListMetadataKeysResponse.

​
metadataKeys
object[]
​
nextPageToken
string