List ad squads
List ad squads. Supply campaignId to list under that campaign directly (no ad account is resolved); omit it to list under an ad account, resolved the same way as GET /v1/snapchat-ads/campaigns. Budget values are micro units of the AD ACCOUNT's currency,…
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
This operation is read-only. Change the path values above and send.
Response
{
"adAccountId": "ada_489573",
"adsquads": [
{}
],
"currency": "EUR",
"status": "success",
"tokensDeducted": 1
}What it does
List ad squads. Supply campaignId to list under that campaign directly (no ad account is resolved); omit it to list under an ad account, resolved the same way as GET /v1/snapchat-ads/campaigns. Budget values are micro units of the AD ACCOUNT's currency, but when listing by campaignId the ad account is never resolved, so adAccountId and currency both come back null. money fields (bid_micro, daily_budget_micro, lifetime_budget_micro) must be interpreted against the ad account obtained separately from GET /v1/snapchat-ads/adaccounts
Request
Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
accountId | query | string | no | Snapchat organization id, required only when several are connected |
adAccountId | query | string | no | Ad account to list under; ignored when campaignId is supplied |
campaignId | query | string | no | List ad squads under this campaign directly, skipping ad account resolution |
Response
| Field | Type | Description |
|---|---|---|
adAccountId | string | |
adsquads | array<object> | |
currency | string | |
status | string | |
tokensDeducted | integer |
Example response
{
"adAccountId": "ada_489573",
"adsquads": [
{}
],
"currency": "EUR",
"status": "success",
"tokensDeducted": 1
}Errors
Every error answers with the same envelope: an HTTP status, a machine code and a sentence.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream refused or timed out. The call is not billed. |
Code
curl -X GET 'https://app.castomapi.com/v1/snapchat-ads/adsquads' \ -H 'x-api-key: <your-api-key>'
const res = await fetch('https://app.castomapi.com/v1/snapchat-ads/adsquads', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/snapchat-ads/adsquads', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import requests
res = requests.get(
'https://app.castomapi.com/v1/snapchat-ads/adsquads',
headers={'x-api-key': '<your-api-key>'},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/snapchat-ads/adsquads');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Cost and limits
This operation costs 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire.
Rate limits per minute
| No key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Questions
What does List ad squads cost?
1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month.
How do I authenticate?
Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.
Can I send an Authorization: Bearer token instead?
Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.
What are the limits?
10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.
OpenAPI: https://app.castomapi.com/docs/json