CIcint
Allocation Templates Admin

List country allocation templates

Returns a paginated list of country-level allocation templates for the given account. You can filter by name, business unit, country code, or default status, and control pagination using the page_size, start_after, and end_before parameters.

get/demand/accounts/{account_id}/country-allocation-templates

Request

Query parameters

searchstring

Filter by search string (currently supports template name).

page_sizeinteger

A limit on the number of objects to be returned, between 1 and 100.

start_afterstring

Returns a list of objects after the provided pagination cursor, using the next_cursor from the previous response.

end_beforestring

Returns a list of objects that come before the provided pagination cursor. This is used for navigating to a previous page.

sort_ascending'asc' | 'desc'

Sort direction. Use "asc" for ascending or "desc" for descending order.

business_unit_idstring

The unique ID of the business unit, which determines the currency used for the target group.

Example:1234

Filter by business unit ID.

country_codestring

Two-letter country code as per ISO 3166-1 alpha-2 standard.

Example:US

Filter by two-letter country code (ISO 3166-1 alpha-2).

is_defaultboolean

Filter by whether the template is the default for the country.

sort_bystring

The field by which to sort the results.

Response

The list of country allocation templates was retrieved successfully.

has_moreboolean required

If there are further results to be shown using the returned next cursor or previous cursor, this will be true, otherwise false.

next_cursorstring required

Provides the string to use as the "start_after" or "end_before" value of the next request. Null if no further results.

Example response

{
  "templates": [
    {
      "template_id": "01JT5Z59MAKQ82J5K9Y3YGFNHN",
      "name": "My Country Template",
      "country_code": "US",
      "business_unit_id": "100",
      "version": 1,
      "last_modified_at": "2024-06-18T14:23:45Z",
      "last_modified_by": "b551326b-ac9d-4d32-8823-4f025787dab9"
    }
  ],
  "next_cursor": "WzAsIjAxSlA3RTgyM0czSFRGOTdZRThBNjc0RU5EIl0="
}

Changes

No recorded changes to this operation across all 1 revision of this API.