# List Audience Segment Taxonomies

Returns a paginated list of audience segment taxonomies, each with its full
nested segment tree. Results can be filtered with `q=` and sorted with `sort_by=`.
**Filterable / sortable fields:**
| Field | Source table |
|  --- | --- |
| `id` | audience_segments |
| `taxonomy_id` | audience_segments |
| `audience_vendor_id` | audience_segments |
| `name` | audience_segments |
| `code` | audience_segments |
| `buyable` | audience_segments |
| `retail_cpm` | audience_segments |
| `wholesale_cpm` | audience_segments |
| `uniques` | audience_segments |
| `visibility` | audience_taxonomies |

Pagination is at the **taxonomy** level: `page_limit=1` returns one complete
taxonomy tree (potentially many segments).

Endpoint: GET /audience_taxonomies
Version: 3.0.1807
Security: Auth0

## Query parameters:

  - `page_limit` (integer)
    Number of elements in the collection to retrieve

  - `page_offset` (integer)
    Index of the first element in the collection to retrieve

  - `sort_by` (string)
    The field to sort by. You can use any field name in ascending or descending order.
For ascending order, use the field name directly, e.g., `id`. 
For descending order, prefix the field name with a hyphen (`-`), e.g., `-id`.

  - `q` (string)
    Query search for filtering. This parameter can be used to filter results based on various fields.
Supported operators:
- `==` - numeric equality or case-sensitive string identity, 
- `==(1,2,3)` - IN query (only works for integers),
- `!=` - numeric inequality or case-sensitive string non-identity,
- `=:` - case-insensitive match, allows substring using * wildcards,
- `<` - less than,
- `<=` - less than or equal to,
- `>` - greater than,
- `>=` - greater than or equal to.
Examples: 
- `q=name=:{search}*` to find all results with names starting with {search}.
- `q=status==true` to find all active entities.
- `q=id>=1000` to find all entities with id greater than or equal to 1000.
- `q=id==(1,2,3)` to find specific entities by ID.
- `q=created_on>1999-02-02` or `q=created_on>1999-02-02T00:00:00Z` to find entities created later than date.
- `q=id>5&status==true` to find all active entities with id greater than 5.

## Response 200 fields (application/json):

  - `data` (array)
    List of audience segment taxonomy items for the current page

  - `data.taxonomy_id` (integer, required)
    ID of the audience_taxonomies row

  - `data.audience_vendor_id` (integer, required)
    ID of the audience_vendors row associated with this taxonomy

  - `data.vendor_id` (integer, required)
    ID of the underlying vendor owning this taxonomy

  - `data.revenue_share_pct` (number)
    Revenue share percentage

  - `data.visibility` (string, required)
    Visibility scope of the taxonomy
    Enum: "GLOBAL", "RESTRICTED"

  - `data.permissions` (object)
    Entity-scoped access permissions. Included only when the caller is authorized to view permissions for this taxonomy.

  - `data.permissions.organizations` (array, required)

  - `data.permissions.agencies` (array, required)

  - `data.permissions.advertisers` (array, required)

  - `data.taxonomy` (object, required)
    Root node of the nested segment tree

  - `data.taxonomy.id` (integer, required)
    ID of the audience_segments row for this node

  - `data.taxonomy.name` (string, required)
    Display name of this segment node

  - `data.taxonomy.code` (string)
    Vendor-defined segment code (raw or CRC32-hashed)

  - `data.taxonomy.buyable` (boolean, required)
    Whether this segment can be purchased/targeted

  - `data.taxonomy.retail_cpm` (number)
    Retail cost per thousand impressions

  - `data.taxonomy.wholesale_cpm` (number)
    Wholesale cost per thousand impressions

  - `data.taxonomy.uniques` (integer)
    Estimated number of unique users in this segment

  - `data.taxonomy.children` (array, required)
    Nested child segment nodes (may be empty)

  - `meta` (object)

  - `meta.status` (string, required)
    The status of the response, indicating success or failure.
    Example: success

  - `meta.count` (integer, required)
    The number of items returned in the current response.
    Example: 10

  - `meta.total_count` (integer)
    The total number of items available in the dataset.
    Example: 100

  - `meta.offset` (integer)
    The offset from the start of the dataset, used for pagination.
    Example: 0

  - `meta.next_page` (string)
    The URL to fetch the next page of results.

  - `meta.prev_page` (string)
    The URL to fetch the previous page of results.

## Response 400 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 401 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 403 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 500 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

