> ## Documentation Index > Fetch the complete documentation index at: https://rankspot.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get the workspace > Returns the brand and business context for the workspace your API key belongs to: brand name, domain, what the business does, who it sells to, tone of voice, industry, and the country and language it targets. There is no path parameter. A key belongs to exactly one workspace, and this returns that one. Read this first if you are deciding what work is worth doing. A keyword, a cited page or a competitor backlink is only an opportunity in the context of a particular business, and every other endpoint assumes you already know what that business is. Fields are read-only and any of them can be null. They shape article generation and the AI visibility analysis, so they are edited in the RankSpot dashboard rather than here. ## OpenAPI ````yaml https://api.rankspot.ai/docs-json get /v1/workspace openapi: 3.0.0 info: title: RankSpot Public API description: >- The RankSpot Public API gives you programmatic access to your workspace data — keywords, backlinks, competitors, planned actions, articles, and more. ## Authentication All endpoints require a Bearer API key in the `Authorization` header: ``` Authorization: Bearer ``` Generate API keys from **Settings → API Keys** in the RankSpot dashboard. Each key is scoped to a single workspace. ## Pagination List endpoints return a consistent envelope: ```json { "data": { "total": 120, "offset": 0, "limit": 20, "count": 20, "items": [...] } } ``` Use `offset` and `limit` query parameters to paginate. Default limit is **20**, maximum is **100**. ## Status codes | Code | Meaning | |------|---------| | 200 | Success | | 201 | Created | | 204 | No content (delete / unarchive) | | 400 | Validation error or business rule violation | | 401 | Missing or invalid API key | | 404 | Resource not found or belongs to another workspace | version: '1.0' contact: {} servers: - url: https://api.rankspot.ai description: Production security: [] tags: - name: AI Visibility description: >- How AI answer engines see your brand. Track prompts, read the answers ChatGPT, Perplexity and Google gave, and work through the pages they cited. Prompts are run on a daily schedule by RankSpot, so answers appear after the next run rather than on demand. - name: Articles description: >- AI-generated blog articles. Articles are created automatically when a `write_article` action is sent to generation — they cannot be created directly via the API. - name: Backlinks description: >- Backlinks discovered for your domain and your competitors' domains. Backlinks are auto-synced on a background interval and cannot be created via the API. - name: Categories description: Categories for organising actions and articles within your workspace. - name: Competitors description: >- Competitor domains tracked in your workspace. Once added, keywords and backlinks for each competitor are fetched asynchronously on a background sync interval. - name: Forum Opportunities description: >- Forum threads and community posts surfaced as potential link-building or engagement opportunities. - name: Keywords description: >- SEO keywords tracked in your workspace, enriched with search volume, competition, and AI-generated relevance scores. - name: People Also Ask description: >- "People also ask" questions discovered from search results for your tracked keywords. - name: Actions description: >- The SEO work planned for your workspace. Each action carries a `type` saying what kind of work it is and which target it points at — see `POST /v1/actions` for the full list. Only `write_article` can be turned into an article; the rest are a person's job. Create actions yourself or let RankSpot generate them. - name: Research description: >- Live lookups against the open web: a Google search and a page fetch. The only endpoints here that spend credits per call. Neither response reports what it cost — the charge is real, and your remaining balance is visible in the RankSpot dashboard. Returns 402 when the workspace is out of credits. - name: Search Console description: >- Google Search Console performance data — clicks, impressions, CTR, and average position for your connected property. Requires GSC to be connected from the RankSpot dashboard. - name: Workspace description: >- Who the workspace is: brand, domain, what the business does and who it sells to. Read this first — the rest of the API returns opportunities that only mean something in the context of a particular business. paths: /v1/workspace: get: tags: - Workspace summary: Get the workspace description: >- Returns the brand and business context for the workspace your API key belongs to: brand name, domain, what the business does, who it sells to, tone of voice, industry, and the country and language it targets. There is no path parameter. A key belongs to exactly one workspace, and this returns that one. Read this first if you are deciding what work is worth doing. A keyword, a cited page or a competitor backlink is only an opportunity in the context of a particular business, and every other endpoint assumes you already know what that business is. Fields are read-only and any of them can be null. They shape article generation and the AI visibility analysis, so they are edited in the RankSpot dashboard rather than here. operationId: WorkspaceController_find parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/WorkspaceDto' security: - bearer: [] components: schemas: WorkspaceDto: type: object properties: id: type: string example: clx... name: type: string example: Screen Studio nullable: true description: The workspace name, which is not necessarily the brand name. brandName: type: string example: Screen Studio nullable: true description: >- How the business refers to itself. This is the name AI visibility counts mentions of. domain: type: string example: https://screen.studio/ nullable: true description: >- The domain this workspace is about. Articles are published here, and a citation or backlink pointing at it is your own rather than an opportunity. Stored as it was entered, so it may be a bare hostname (`screen.studio`) or a full URL with a scheme and a trailing slash (`https://screen.studio/`). Elsewhere in the API a domain is always a bare hostname, so strip the scheme and any trailing slash before comparing. businessDescription: type: string example: >- A macOS app that records your screen and turns the footage into a polished video automatically. nullable: true description: What the business does, in its own words. targetAudience: type: string example: Indie developers, designers and founders who publish demo videos. nullable: true description: Who the business sells to. benefits: type: string example: Automatic zooms, no editing skills needed, exports in 4K. nullable: true description: What the business argues is better about it. toneOfVoice: type: string example: Direct and practical, no marketing filler. nullable: true description: How generated content should sound. industry: type: string example: Software nullable: true location: type: string example: US nullable: true description: >- ISO 3166-1 alpha-2 country the workspace targets. Search results, keyword volumes and rankings are all reported for this market. language: type: string example: en nullable: true description: ISO 639-1 language content is written in. required: - id securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````