Core resource
Profile groups
Use a profile group as the durable publishing boundary for one customer, brand, or workspace.
3
Endpoint summary
All operations in this resource, with the minimum accepted key scope.
Method & endpointPurposeScope
GET
/api/profile-groupsList visible profile groups
readPOST
/api/profile-groupsCreate a profile group
fullDELETE
/api/profile-groups/{id}Delete a profile group
full01
Create one group per tenant
The group owns connected profiles, schedules, posts, and group-bound API keys. Store its
id beside your own tenant identifier.Create a profile groupPostGate API
curl -X POST https://postgate.studio/api/profile-groups \
-H "Authorization: Bearer $POSTGATE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Inc.",
"timezone": "America/New_York",
"brand": { "external_id": "tenant_842" }
}'02
Prefer group-bound keys for embedded products
A key created with
group_id cannot read or mutate another customer’s data. This makes the boundary enforceable even if application code accidentally sends the wrong query parameter.03
Deletion is cascading
Deleting a group removes its profiles and dependent tenant data. Treat the operation as an offboarding action, not a way to clear content during development.
Use a test group during development
Keep production tenants and disposable fixtures in separate groups and use a
pg_test_ key for fixtures.