Get the catalog
What the workspace’s data looks like: every object with its fields (type, description, whether it can be filtered and grouped), the relationships between them, every event name with its property keys and types, the custom fields of profiles, and the computed traits. Read it before asking anything of the data.
What the workspace’s data looks like: every object with its fields (type, description, whether it can be filtered and grouped), the relationships between them, every event name with its property keys and types, the custom fields of profiles, and the computed traits. Read it before asking anything of the data.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
OK
application/json- response
objects*array<|>relationships*array<>events*array<>customFields*array<>computedTraits*array<>curl -X GET 'https://api.postforge.dev/v1/catalog'{ "objects": [ { "kind": "built_in", "key": "store", "label": "string", "description": "string", "fields": [ { "key": "string", "description": "string", "type": "string", "nullable": true, "values": [ "string" ], "references": "string", "filterable": true, "groupable": true } ] } ], "relationships": [ { "from": "string", "key": "string", "to": "string", "cardinality": "one", "description": "string" } ], "events": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "properties": [ { "key": "string", "types": [ "string" ] } ] } ], "customFields": [ { "key": "string", "label": "string", "description": "string", "type": "text", "platform": "string" } ], "computedTraits": [ { "key": "string", "label": "string", "description": "string", "object": "string", "type": "string", "definition": { "aggregate": "count", "over": "string", "field": "string", "where": "string", "perCurrency": true }, "builtIn": true } ]}Search the workspace GET
Profiles (name, email or phone), orders (number, or the buyer’s exact email), products (title, vendor, handle, SKU or id), coupons (name or prefix), feeds (name or URL) and stores (name or domain): the first few of each kind and how many match.
List event types GET
Every event name the workspace has, with when its oldest and newest events happened.