# List Search keywords

Returns Search keywords, one page at a time. Works with Google Ads.

```http
GET https://api.pozy.ai/v1/ads/keywords
```

- Area: Ads / Ad Campaigns
- Auth: Authorization: Bearer pz_live_...

## Query parameters

- `page` (integer)
- `limit` (integer)
- `accountId` (string)
- `adAccountId` (string)
- `profileId` (string)
- `campaignId` (string)
- `adSetId` (string)
- `status` (string): one of active, paused
- `matchType` (string): one of exact, phrase, broad, unknown
- `negative` (boolean)
- `search` (string)

## Example request

```bash
curl -X GET "https://api.pozy.ai/v1/ads/keywords?limit=50" \
  -H "Authorization: Bearer $POZY_API_KEY"
```

```ts
const res = await fetch("https://api.pozy.ai/v1/ads/keywords?limit=50", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);
```

```python
import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/ads/keywords",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 50,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())
```

## Response 200

- `keywords`, array of object
  - `id`, string
  - `platformCriterionId`, string
  - `resourceName`, string
  - `accountId`, string
  - `profileId`, string
  - `platform`, string: One of `google`
  - `adAccountId`, string
  - `campaignId`, string
  - `campaignName`, string: Can be null
  - `campaignStatus`, string: Can be null
  - `adSetId`, string
  - `adSetName`, string: Can be null
  - `adSetStatus`, string: Can be null
  - `keyword`, string
  - `matchType`, string: One of `exact`, `phrase`, `broad`, `unknown`
  - `status`, string: One of `active`, `paused`
  - `negative`, boolean
  - `qualityScore`, integer: Can be null
  - `quality`, object
    - `score`, integer: Can be null
    - `expectedCtr`, string: One of `BELOW_AVERAGE`, `AVERAGE`, `ABOVE_AVERAGE`. Can be null
    - `adRelevance`, string: One of `BELOW_AVERAGE`, `AVERAGE`, `ABOVE_AVERAGE`. Can be null
    - `landingPageExperience`, string: One of `BELOW_AVERAGE`, `AVERAGE`, `ABOVE_AVERAGE`. Can be null
  - `syncedAt`, string (date-time): Can be null
  - `metrics`, object: Can be null
    - `windowDays`, integer
    - `clicks`, integer
    - `impressions`, integer
    - `cost`, number
    - `conversions`, number
    - `firstPageCpc`, number: Can be null
    - `firstPositionCpc`, number: Can be null
- `pagination`, object
  - `page`, integer
  - `limit`, integer
  - `total`, integer
  - `pages`, integer

```json
{
  "keywords": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "platformCriterionId": "6882078ac440c35a806f87dc",
      "resourceName": "Acme",
      "accountId": "696e0b682d0a31188e7a2ba9",
      "profileId": "6a0b6573846efc28aaa9a3ff",
      "platform": "google",
      "adAccountId": "666219aad7bab67ace411e4f",
      "campaignId": "65a3737dd8b11ea61f199e6e",
      "campaignName": "Acme",
      "campaignStatus": "active",
      "adSetId": "60484b408d44e7c2492bfec5",
      "adSetName": "Acme",
      "adSetStatus": "active",
      "keyword": "string",
      "matchType": "exact",
      "status": "active",
      "negative": true,
      "qualityScore": 1,
      "quality": {
        "score": 1,
        "expectedCtr": "BELOW_AVERAGE",
        "adRelevance": "BELOW_AVERAGE",
        "landingPageExperience": "BELOW_AVERAGE"
      },
      "syncedAt": "2026-10-02T09:00:00.000Z",
      "metrics": {
        "windowDays": 1,
        "clicks": 1,
        "impressions": 1,
        "cost": 12.5,
        "conversions": 12.5,
        "firstPageCpc": 12.5,
        "firstPositionCpc": 12.5
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 42,
    "pages": 1
  }
}
```