List the profiles on a list
Who is on it, the latest added first, with the address on the list and how it was added; search by name, email or phone.
Who is on it, the latest added first, with the address on the list and how it was added; search by name, email or phone.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*string^(list)_[0-9A-Za-z]{8}$page?integerStarts at 1
1 <= value1pageSize?numberOne of 10, 25, 50, 100
25q?stringSearch
1 <= length <= 200sort?stringOne of addedAt; prefix with - for descending
"-addedAt""addedAt""-addedAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/lists/string/profiles'{ "items": [ { "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "name": "string", "address": "string", "addedAt": "2019-08-24T14:15:22Z", "source": { "kind": "store", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "platform": "string" }, "apiKey": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "import": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "origin": "customer" } } ], "total": 0, "page": 0, "pageSize": 0}Delete a list DELETE
The list and every membership go. The people stay, and their timelines keep the *List Joined* events, which name the list.
Add profiles to a list POST
Each profile’s email address goes on the list (its phone number when it has no email address): the membership stays with that address, also when profiles merge. Up to 1,000 profiles per call; profiles that aren’t found or have neither are in `skipped`. Each one added gets *List Joined* on their timeline.