Ads · Product Catalogs

Get a product catalog

Fetches a product catalog. Works with Meta Ads.

GEThttps://api.pozy.ai/v1/ads/catalogs/{catalogId}

Facebook and InstagramgetAdCatalog

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`catalogId`required	string

Query parameters

Name	Type	Notes
`accountId`required	string
`catalogAccountId`	string

Example

curl -X GET "https://api.pozy.ai/v1/ads/catalogs/6f2f2ffcf4ace3659342c4c2?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/ads/catalogs/6f2f2ffcf4ace3659342c4c2?accountId=696e0b682d0a31188e7a2ba9", {
  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);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/ads/catalogs/6f2f2ffcf4ace3659342c4c2",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

catalogobject
- idstring
- namestring
- verticalstring
  Can be null.
- productCountinteger
- businessIdstring
  Can be null.

200 response

{
  "catalog": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "vertical": "string",
    "productCount": 42,
    "businessId": "68520dbeeafb126eab3873f6"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Product Catalogs

GETList Meta product catalogs POSTCreate a Meta product catalog DELDelete a product catalog GETList a catalog's products POSTAdd a product to a catalog POSTCreate, update or delete products in bulk GETGet a bulk request's status GETGet a product PUTUpdate a product DELDelete a product GETList a catalog's product feeds POSTCreate a product feed GETList a feed's uploads POSTFetch a feed file now GETList a catalog's product sets POSTCreate a product set PUTUpdate a product set DELDelete a product set