List the Placements
Lists the live Placements that your organization sees, newest first: its own, and the global ones that AdCrunch holds for every organization. A Placement is the slot where a provider shows an ad, and its rules say what an Asset should hold to fit. isGlobal tells you which rows you cannot change.
Filter with channel, type and groupId. One page at a time: limit rows at most, 100 by default. When the answer holds nextCursor, more rows exist: send it back as cursor to get the next page. A cursor of another filter is refused.
/library/placementsAuthorizationBearer token · headerrequiredSend Authorization: Bearer <credential>.
Use an API key (acr_…), from the AdCrunch console under Settings → API keys.
The credential names the organization, and no operation takes an organization parameter.
See https://docs.adcrunch.dev/api/authentication.
cursorstringThe nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.
limitintegerrequiredThe greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request.
channelstringOnly the Placements of this channel.
metatiktoksnapchatgoogle_searchgoogle_pmaxgoogle_displayyoutubeprogrammatic_displaylinkedinxgroupIdstringOnly the Placements that this group holds. A group that your organization does not see answers 404.
typestringOnly the Placements of this type.
imagevideoOne page of the Placements, newest first. This page is the last one, so it carries no nextCursor.
dataobject[]requiredShow propertiesHide properties
objectchannelstringrequiredThe channel of a Line Item that the Placement belongs to. It never changes.
metatiktoksnapchatgoogle_searchgoogle_pmaxgoogle_displayyoutubeprogrammatic_displaylinkedinxcreatedAtnumberrequiredMilliseconds since the Unix epoch, UTC.
createdBystring | nullrequiredThe user who created the Placement. null on a global row.
deletedAtnumber | nullrequiredAlways null here. A deleted Placement is not answered.
descriptionstring | nullrequiredA free text. null when the Placement has none.
idstringrequiredThe id of the Placement, plm_….
isGlobalbooleanrequiredtrue on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.
namestringrequiredThe name, 1 to 80 characters. It is unique, ignoring case, among the Placements of the channel that the organization sees.
organizationIdstring | nullrequiredThe organization that owns the Placement. null on a global row.
paramsobjectrequiredShow propertiesHide properties
rulesobject[]requiredShow propertiesHide properties
objectoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredwidthoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredheightoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredsizeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequirednevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredinvalueinteger[][]requiredtypestringrequiredratiooperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvaluestringrequiredconditionstringrequirednevaluestringrequiredconditionstringrequiredinvaluestring[]requiredtypestringrequiredmimetypestringrequiredimagerulesobject[]requiredShow propertiesHide properties
objectoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredwidthoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredheightoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequiredsizeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequirednevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredltevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtvalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredgtevalueinteger[]requiredShow propertiesHide properties
integerintegerintegerconditionstringrequiredinvalueinteger[][]requiredtypestringrequiredratiooperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvaluestringrequiredconditionstringrequirednevaluestringrequiredconditionstringrequiredinvaluestring[]requiredtypestringrequiredmimeoperatorobjectrequiredShow propertiesHide properties
conditionstringrequiredeqvalueintegerrequiredconditionstringrequirednevalueintegerrequiredconditionstringrequiredltvalueintegerrequiredconditionstringrequiredltevalueintegerrequiredconditionstringrequiredgtvalueintegerrequiredconditionstringrequiredgtevalueintegerrequiredconditionstringrequiredinvalueinteger[]requiredtypestringrequireddurationtypestringrequiredvideotypestringrequiredThe kind of Asset that the slot takes. It never changes, and it equals params.type.
imagevideoupdatedAtnumber | nullrequiredWhen the Placement last changed. null until its first update.
nextCursorstringSend this value as cursor to get the next page. It is absent on the last page.
The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed. Or AdCrunch cannot use the cursor: it cannot read it, or the cursor belongs to a different query. Then error is invalid_cursor. Send the nextCursor of the previous page with no change, or omit cursor to get the first page.
issuesobject[]requiredOne entry for each field that does not match.
Show propertiesHide properties
objectinstringrequiredThe part of the request that holds the field.
bodycookieheadersparamsquerymessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
pathstringrequiredA JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_requestmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_cursormessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No API key, or one that does not resolve. See the security scheme. error is unauthorized.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
unauthorizedmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.
paywallUrlstring<uri>requiredThe page where an owner of the organization subscribes. Show it to the person.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
organization_unentitledmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The caller does not hold library:read. error is forbidden.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
forbiddenmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The groupId names no group that your organization sees. error is not_found.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
messagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.