ListUnits - Sift Docs

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 units to return. The service may return fewer than this value. If unspecified, at most 50 units 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 ListUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUnits must match the call that provided the page token.

filter

string

A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are:

abbreviated_name
name
created_date
unit_id

orderBy

string

How to order the retrieved campaigns. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date, and abbreviated_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,abbreviated_name"

Response

A successful response.

units

object[]

required

Show child attributes

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.