Workspace
Get workspace
Reads the connected workspace's identity (name, slug) and echoes back which scopes the calling API key has. With profiles:read it also lists the connected LinkedIn profiles, company pages and X accounts. Intended as a first call to confirm the key is pointed at the right org.
/api/public/workspacecurl "https://postiv.ai/api/public/workspace" \
-H "Authorization: Bearer pk_postiv_..."{
"success": true,
"workspace": {
"id": "9e6397ad-0000-0000-0000-000000000000",
"name": "Postiv AI",
"slug": "postiv-ai",
"createdAt": "2026-01-04T10:00:00.000Z",
"scopes": [
"workspace:read",
"posts:read",
"posts:write"
]
}
}Authorization
Requires an organization API key with the workspace:read scope, sent as Authorization: Bearer or x-api-key.
Response
The organization plus the caller's own scope list.
workspace.iduuidOrganization id.
workspace.namestringOrganization display name.
workspace.slugstringOrganization slug.
workspace.createdAttimestampOrg creation time.
workspace.scopesstring[]Scopes granted to this API key.
workspace.accounts[]arrayOnly with profiles:read. Every connected LinkedIn profile, company page and X account, with the fields of the MCP tool list_social_accounts: id, channel, provider, profileType, parentIntegrationId, name, username, headline, picture, status, socialSetId.
workspace.socialSets[]arrayOnly with profiles:read. Groups of linked accounts that belong to one brand, such as a LinkedIn profile and its X account: { id, name, integrationIds }.
Errors
| 404 | workspace_not_found: the key's org_id no longer resolves to an organizations row |
Good to know
- Also exposed as the MCP tool get_workspace, recommended as the very first call in a session.
- A key without profiles:read gets the workspace without accounts and socialSets. This is the REST way to find an X account's integrationId; GET /api/public/linkedin-profiles lists LinkedIn only.