Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview

List the Placement groups

Lists the live Placement groups that your organization sees, newest first: its own, and the global ones, one for each channel that has Placements. A group holds no Placement in this list. The read of one group holds them. isGlobal tells you which rows you cannot change.

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.

GET/library/placement-groups
Authorization
AuthorizationBearer token · headerrequired

Send 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.

Query parameters
cursorstring

The 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.

min length 1
limitintegerrequired

The 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.

min 1 · max 500 · default: 100
Responses
200

One page of the groups, newest first. This page is the last one, so it carries no nextCursor.

dataobject[]required
Show properties
Array of object
createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystring | nullrequired

The user who created the group. null on a global row.

deletedAtnumber | nullrequired

Always null here. A deleted group is not answered.

descriptionstring | nullrequired

A free text. null when the group has none.

idstringrequired

The id of the group, plg_….

isGlobalbooleanrequired

true on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.

namestringrequired

The name, 1 to 80 characters. It is unique, ignoring case, among the groups that the organization sees.

organizationIdstring | nullrequired

The organization that owns the group. null on a global row.

updatedAtnumber | nullrequired

When the group last changed. null until its first update.

nextCursorstring

Send this value as cursor to get the next page. It is absent on the last page.

400

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.

Any of:
object
issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

object
errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_cursor
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:organization_unentitled
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold library:read. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request
curl -X GET 'https://api.pr-1339.adcrunch.dev/library/placement-groups?limit=100' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "createdAt": 1790000600000,
      "createdBy": "usr_2e5b84",
      "deletedAt": null,
      "description": null,
      "id": "plg_9e1c53",
      "isGlobal": false,
      "name": "Vertical video",
      "organizationId": "org_3a7f10",
      "updatedAt": null
    },
    {
      "createdAt": 1789000000000,
      "createdBy": null,
      "deletedAt": null,
      "description": null,
      "id": "plg_meta",
      "isGlobal": true,
      "name": "Meta",
      "organizationId": null,
      "updatedAt": null
    }
  ]
}

Was this page helpful?