List a profile’s custom fields
Every custom field the person has a value in, with where the value came from (a store, the API, a person in the dashboard) and when it was written there. Search matches a field’s name, key or value.
Every custom field the person has a value in, with where the value came from (a store, the API, a person in the dashboard) and when it was written there. Search matches a field’s name, key or value.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringuuidpage?integerStarts at 1
1 <= value1pageSize?numberOne of 10, 25, 50, 100
25q?stringSearch
1 <= length <= 200source?stringComma-separated, any of: store, import, api, manual, automation, merge
type?stringComma-separated, any of: text, number, boolean, date, list, json
sort?stringOne of label, updatedAt; prefix with - for descending
"label""label""-label""updatedAt""-updatedAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08/custom-fields'{ "items": [ { "field": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "label": "string", "description": "string", "type": "text", "platform": "string", "archivedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "value": "string", "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" }, "origin": "string" }, "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}List a profile’s identities GET
Every identifier the person is known by.
List the changes to a profile’s custom field GET
Every change to the field for this person, newest first by when it happened at its source, kept 13 months: old and new value, where it came from, refused writes with why, and for a store’s field changed in Postforge how sending it to the store went.