> ## 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. # List keywords > Returns a paginated list of keywords. By default, archived keywords are excluded (`type=all`). Filter by `type` to view planned, processed, new, or archived keywords. Filter by `keyword` substring or `competitorId`. Sort by any scored field. ## OpenAPI ````yaml https://api.rankspot.ai/docs-json get /v1/keywords 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, content topics, 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: Articles description: >- AI-generated blog articles. Articles are created automatically when a topic 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 topics 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: Topics description: >- Content topic ideas that can be turned into articles. Create topics manually or let RankSpot generate them from your keyword clusters. - 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. paths: /v1/keywords: get: tags: - Keywords summary: List keywords description: >- Returns a paginated list of keywords. By default, archived keywords are excluded (`type=all`). Filter by `type` to view planned, processed, new, or archived keywords. Filter by `keyword` substring or `competitorId`. Sort by any scored field. operationId: KeywordsController_findAll parameters: - name: offset required: false in: query schema: minimum: 0 default: 0 type: number - name: limit required: false in: query schema: minimum: 1 maximum: 100 default: 20 type: number - name: keyword required: false in: query description: Filter by keyword substring schema: type: string - name: competitorId required: false in: query description: Filter by competitor ID schema: type: string - name: sortBy required: false in: query schema: default: compositeScore type: string enum: - opportunityIndex - competitionIndex - searchVolume - compositeScore - aiScore - name: sortOrder required: false in: query schema: default: desc type: string enum: - asc - desc - name: type required: false in: query description: >- all: all non-archived | planned: linked to a topic but no article yet | processed: has a linked article | new: no topic or article | archived: archived keywords schema: type: string enum: - all - planned - processed - new - archived responses: '200': description: '' content: application/json: schema: properties: data: type: object properties: total: type: number example: 100 offset: type: number example: 0 limit: type: number example: 100 count: type: number example: 10 items: type: array items: $ref: '#/components/schemas/KeywordDto' security: - bearer: [] components: schemas: KeywordDto: type: object properties: id: type: string example: clx... keyword: type: string example: start blog competition: type: string example: MEDIUM nullable: true competitionIndex: type: number example: 60 nullable: true searchVolume: type: number example: 27100 nullable: true opportunityIndex: type: number example: 10 nullable: true aiScore: type: number example: 74 nullable: true compositeScore: type: number example: 68 nullable: true competitorId: type: string example: clx... nullable: true topicIds: example: - clx... type: array items: type: string articleIds: example: - clx... type: array items: type: string createdAt: format: date-time type: string example: '2026-06-21T19:02:30.542Z' updatedAt: format: date-time type: string example: '2026-06-21T19:02:30.542Z' required: - id - keyword - competition - competitionIndex - searchVolume - opportunityIndex - aiScore - compositeScore - topicIds - articleIds - createdAt - updatedAt securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````