List profiles
The workspace’s people, most recently seen first.
GET
The workspace’s people, most recently seen first.
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 <= 200store?stringComma-separated ids
customer?stringOnly people who did (true) or didn’t (false) place an order
Value in
"true""false"sort?stringOne of lastSeenAt, firstSeenAt; prefix with - for descending
Default
"-lastSeenAt"Value in
"lastSeenAt""-lastSeenAt""firstSeenAt""-firstSeenAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integerall*integercurl -X GET 'https://api.postforge.dev/v1/profiles'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string", "phone": "string", "locale": "string", "storeIds": [ "636b56cb-e414-46d5-b6c0-0e73b3e0106b" ], "isCustomer": true, "emailMarketingConsent": "subscribed", "smsMarketingConsent": "subscribed", "firstSeenAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0, "all": 0}