Skip to content
Livstick Developers
v3 Request access

Code groups

One operation: list the code groups belonging to the authenticated platform.

v3 Base URL https://client-api.v5.livstick.com/api/v3

What a code group is

A code group is a batch: containers created ahead of time, before anyone knows who will end up using each one — the mechanism behind journeys built on a pre-printed physical support. See the concept page for how a code group is set at container creation. Cross-reference: GET /messages accepts a codeGroupId query parameter to scope its list to one code group.

Operations

Method GET /code-groups

Scope code_groups:read

Lists code groups for the authenticated platform, paginated.

Parameters

Name In Type Required Description
limit Query integer Optional Maximum number of items to return. Default 50, maximum 200.
skip Query integer Optional Number of items to skip (pagination offset). Default 0.
order Query string Optional Sort field, prefixed with - for descending. Default -createdAt.

Response

json 200 
{
  "items": [
    {
      "objectId": "grp456",
      "name": "Spring Campaign",
      "publicId": "spring-launch",
      "status": 0,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ],
  "total": 5,
  "limit": 50,
  "skip": 0
}