API referenceLists
List lists
Every list with how many profiles are on it now; search by name.
GET
Every list with how many profiles are on it now; search by name.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200sort?stringOne of name, createdAt; prefix with - for descending
Default
"name"Value in
"name""-name""createdAt""-createdAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/lists'{ "items": [ { "id": "string", "name": "string", "description": "string", "folder": { "id": "string", "name": "string" }, "profilesCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}List lists and segments GET
Both kinds of audience in one list: `type` keeps one, `folder` is a folder’s id (what’s directly in it), `top` (the top level) or `all`; without it, a search looks everywhere and a plain list shows the top level. A list says how many profiles are on it; a segment’s count is an audience count. Archived segments are left out.
Create a list POST
409 `list_exists` when the workspace has a list of that name.