Workspaces
Get Workspace Profile
Reads the workspace's company profile: website, description, keywords, subreddits, competitors and brand names.
GET
https://app.tryredrover.com/api/public/v1/workspace/profileScope:
workspace:readAI Connector Tool: redrover_get_workspace_profileHeaders
AuthorizationstringRequiredBearerfollowed by anrr_live_API key or a connected app's access token. See Authentication.X-Workspace-IdstringRequiredThe workspace to act on, from List Workspaces.
UUID
Response
200 The profile.
dataobjectRequiredShow 8 Child FieldsHide Child Fields
idstringRequiredWorkspace ID
namestringRequiredCompany or workspace name
websitestringRequiredCompany website
nullable
descriptionstringRequiredWhat the company does
nullable
keywordsstring[]RequiredTarget keywords
subredditsstring[]RequiredSubreddits to focus on, as bare names
competitorsobject[]RequiredTracked competitors
Show 2 Child FieldsHide Child Fields
namestringRequiredwebsitestringRequired
brandNamesstring[]RequiredBrand names our checks accept in content
Errors
Every error uses the error envelope.
401The Authorization header is missing, or the key is invalid or revoked403The key lacks the endpoint's scope, or cannot reach the workspace429More than 120 requests in a minute. Wait for Retry-After seconds500Something went wrong on our side
curl "https://app.tryredrover.com/api/public/v1/workspace/profile" \
-H "Authorization: Bearer $REDROVER_API_KEY" \
-H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"{
"data": {
"id": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
"name": "Acme Analytics",
"website": "https://acme.example",
"description": "Product analytics for small SaaS teams.",
"keywords": [
"product analytics",
"saas metrics"
],
"subreddits": [
"startups",
"SaaS"
],
"competitors": [
{
"name": "Example Metrics",
"website": "https://metrics.example"
}
],
"brandNames": [
"Acme",
"Acme Analytics"
]
}
}