---
title: "Search Online Ads"
method: GET
path: "/business/v2/online-ads"
tags: ["Online Ads"]
---

# Search Online Ads

`GET /business/v2/online-ads`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/online-ads`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `online_ads_read`

Endpoint to search `OnlineAds` using filtering parameters.

## Query parameters

- `text` string: A simple text to search in the `OnlineAds` data (name, description, assignee name).
- `platforms` OnlineAdsPlatform[]: The `OnlineAds` platform.
- `assignees` string[]: The `OnlineAds` assignees.
- `statuses` OnlineAdsStatus[]: The Online Ad status.
- `p` integer: It indicates the specific page to display (the counter starts from zero).
- `s` integer: It indicates the number of items per page.
- `d` 'ASC' | 'DESC': It indicates how the pages are ordered.
- `props` string[]: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.

## Response `200`

The result is an array containing `OnlineAds`.

- OnlineAdsList
  - `total` integer: It represents the total number of available items in the list.
  - `pages` integer: It represents the total number of available pages.
  - `page_size` integer: It represents the number of items per page.
  - `current_page` integer: It indicates the current page (the counter starts from zero).
  - `results_size` integer: It indicates the size of the array results.
  - `results` OnlineAds[]
    - `id` string: The `OnlineAds` ID.
    - `name` string: The name of the `OnlineAds`.
    - `description` string: A custom description of the `OnlineAds`.
    - `platform` 'GOOGLE' | 'TWITTER' | 'TABOOLA' | 'PINTEREST' | 'MICROSOFT' | 'FACEBOOK' | 'AMAZON' | 'APPLE' | 'TIKTOK' | 'LINKEDIN' | 'INSTAGRAM' | 'OTHER'
    - `assignees` string[]: List of `User` IDs currently assigned to the `OnlineAds` and its `Cards`.
    - `status` 'ACTIVE' | 'ASSIGNED' | 'CANCELLED'
    - `wallet_id` string: The `Wallet` ID the `OnlineAds` and its `Card` are linked to.
    - `last_spent_date` string: The date and time of the last `Transaction` made with the `Card`.
    - `last_spent` number: The amount of the last `Transaction` made with the `Card`.
    - `total_spent` number: The overall amount spent with the `Card`.
    - `card_id` string: The ID of the `Card` reserved for this `OnlineAds` (only available after the `OnlineAds` has been activated).
    - `creation_time` string: The date and time when the `OnlineAds` was created.
    - `last_update_time` string: The date and time when the `OnlineAds` was last updated.

## Other responses

- `400`: Your request has missing arguments or is malformed.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)