List all groups

Updated:

GET/ads/{connection_id}/group

Returns a list of AdsGroups. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
org_idstring
The org ID to filter by (reference to AdsOrganization)
campaign_idstring
The campaign ID to filter by
parent_idstring
The parent ID to filter by
io_idstring
The IO ID to filter by
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
statusstring
The status to filter by
effective_status enum
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The ad group's name
parent_idstring
campaign_idstring
The ID of the campaign the ad group belongs to (an AdsCampaign ID)
organization_idstring
insertionorder_idstring
status enum
Valid values:
"UNSPECIFIED"
"ACTIVE"
"PAUSED"
"ARCHIVED"
"DRAFT"
effective_status enum
Valid values:
"UNSPECIFIED"
"SERVING"
"LIMITED"
"LEARNING"
"PAUSED"
targetingobject
bid_amountnumber
bid_strategyobject
YOUTUBE_AND_PARTNERS
budget_amountnumber
budget_period enum
Valid values:
"DAILY"
"MONTHLY"
"TOTAL"
"LIFETIME"
budget_allocation_type enum
Valid values:
"UNSPECIFIED"
"AUTOMATIC"
"FIXED"
"UNLIMITED"
start_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
budget_unit enum
Valid values:
"UNSPECIFIED"
"CURRENCY"
"IMPRESSIONS"
budget_max_amountnumber
type enum
Valid values:
"TEXT"
"IMAGE"
"VIDEO"
"RESPONSIVE"
"SHOPPING"
has_eu_political_adsboolean
pacingobject
frequency_capobject
creative_idsstring array
optimization_goal enum
Valid values:
"REACH"
"IMPRESSIONS"
"LINK_CLICKS"
"LANDING_PAGE_VIEWS"
"CONVERSIONS"
Optimization goals for ads_group (cross-platform; platform-specific values allowed as pass-through)
billing_event enum
Valid values:
"IMPRESSIONS"
"LINK_CLICKS"
"VIDEO_VIEWS"
"APP_INSTALLS"
"ENGAGEMENT"
Billing events for ads_group (what you pay for; cross-platform; platform-specific values allowed as pass-through)
currencystring
promoted array
language_localestring
Language + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale
creative_selection enum
Valid values:
"OPTIMIZED"
"ROUND_ROBIN"
"WEIGHTED"
"SEQUENTIAL"
Creative rotation strategy (LinkedIn creativeSelection)
metadata array
delivery_type enum
Valid values:
"STANDARD"
"SPONSORSHIP"
"NETWORK"
"BULK"
"PRICE_PRIORITY"
Ad server line item type / delivery class (Google Ad Manager lineItemType)
prioritynumber
Ad server delivery priority, lower serves first (Google Ad Manager priority, Kevel priority)
cost_type enum
Valid values:
"CPM"
"VIEWABLE_CPM"
"CPC"
"CPD"
"CPA"
How the line item is priced (Google Ad Manager costType)
delivery_goalobject
Booked delivery goal (Google Ad Manager goal)
creative_sizes array
Expected creative sizes (Google Ad Manager creativePlaceholders)
conversion_tracking array
Conversion trackers counted for this group (DV360 Floodlight activities, Pinterest conversion tag)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/ads/5de520f96e439b002043d8dc/group',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    org_id: '',
    campaign_id: '',
    parent_id: '',
    io_id: '',
    start_gte: '',
    end_lt: '',
    status: '',
    effective_status: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?