> ## Documentation Index
> Fetch the complete documentation index at: https://docs.surnex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List persisted keyword research jobs

> List all keyword research jobs for a project, ordered newest-first. Use this to display job history and poll for completed results.



## OpenAPI

````yaml https://api.surnex.io/openapi.json get /v1/projects/{project_id}/keywords/research
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/keywords/research:
    get:
      tags:
        - Keywords
      summary: List persisted keyword research jobs
      description: >-
        List all keyword research jobs for a project, ordered newest-first. Use
        this to display job history and poll for completed results.
      operationId: >-
        list_keyword_research_jobs_v1_projects__project_id__keywords_research_get
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 25
            title: Per Page
          description: Items per page
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_KeywordResearchJobResponse_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_KeywordResearchJobResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          items:
            $ref: '#/components/schemas/KeywordResearchJobResponse'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - data
        - meta
      title: PaginatedResponse[KeywordResearchJobResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    KeywordResearchJobResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        org_id:
          type: string
          format: uuid
          title: Org Id
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
        status:
          type: string
          title: Status
        research_type:
          type: string
          title: Research Type
        input_params:
          additionalProperties: true
          type: object
          title: Input Params
        results_data:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Results Data
        result_count:
          type: integer
          title: Result Count
          default: 0
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
        created_by:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - org_id
        - status
        - research_type
        - input_params
        - created_at
        - updated_at
      title: KeywordResearchJobResponse
      description: |-
        Full response model for a KeywordResearchJob record.

        Attributes:
            id: UUID of the job record.
            org_id: Organization this job belongs to.
            project_id: Optional project scope.
            status: Current lifecycle state (pending, processing, completed, failed).
            research_type: Type of research that was requested.
            input_params: Original request parameters passed to the worker.
            results_data: Keyword result rows once the job completes.
            result_count: Number of result rows returned.
            error_message: Error detail when status is 'failed'.
            completed_at: Timestamp when the job transitioned to completed/failed.
            created_by: UUID of the user who started the job.
            created_at: Record creation timestamp.
            updated_at: Record last-modified timestamp.
    PaginationMeta:
      properties:
        page:
          type: integer
          minimum: 1
          title: Page
          description: Current page number (1-indexed)
        per_page:
          type: integer
          maximum: 500
          minimum: 1
          title: Per Page
          description: Number of items per page
        total:
          type: integer
          minimum: 0
          title: Total
          description: Total number of items across all pages
      type: object
      required:
        - page
        - per_page
        - total
      title: PaginationMeta
      description: Pagination metadata included in list responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````