younifyd
Menu

Get Audiences

List audiences

GET/v1/audiences

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Audiences action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getAudiences.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets. - When `true`: `totalResultSize` contains the total number of results for this query. - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.

Response

Returns 200 with an object. Read it in later steps with {{getAudiences.response.data.<field>}}.

hasMoreboolean
totalResultSizeinteger (int64)
dataarray<object>
accountIdinteger (int64)required

The ID of the account that owns this entity.

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

namestringrequired

The human-friendly display name for this audience.

sandboxboolean

Indicates if this is a live or sandbox Application.

descriptionstring

A description of the audience.

integrationstring

The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Shopify`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property.

integrationIdstring

The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property.

createdIn3rdPartyboolean

Determines if this audience is a 3rd party audience or not.

lastUpdatestring (date-time)

The last time that the audience memberships changed.

json
{
  "data": [
    {
      "accountId": 3886,
      "created": {},
      "lastUpdate": {},
      "name": "Travel audience",
      "sandbox": true,
      "integration": "mparticle",
      "description": "Travel audience 18-27",
      "integrationId": "382370BKDB946",
      "id": 6,
      "createdIn3rdParty": false
    }
  ],
  "hasMore": false,
  "totalResultSize": 1
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.