Core Concepts
Workspaces
Every request acts on one workspace, picked with the X-Workspace-Id header.
A workspace holds one company's content, profile and results. Agencies usually have one workspace per client. Your key or connected app can reach the workspaces it was linked to, and only those you are a member of.
The X-Workspace-Id Header
Send the workspace's ID in X-Workspace-Id on every request except List Workspaces, which tells you the IDs. A request without the header, or for a workspace the credential cannot reach, fails before anything runs.
curl "https://app.tryredrover.com/api/public/v1/workspace/profile" \
-H "Authorization: Bearer $REDROVER_API_KEY" \
-H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"Keys With One Workspace
Check Content and Rewrite Content fall back to the key's workspace when it can reach exactly one. Every other endpoint needs the header, so send it everywhere to keep things simple.
Workspace Errors
| Status | When |
|---|---|
400 invalid_request | The header is missing |
403 forbidden | The key is not linked to the workspace, or the signed-in person is not a member of it |
404 not_found | The ID is not a workspace ID, or the workspace does not exist or was deleted |
