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

# Get scorecard template by ID

> Retrieve a single scorecard template by its UUID, including all criteria (active + archived).



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/scorecard-templates/{id}
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/scorecard-templates/{id}:
    get:
      tags:
        - Scorecards
      summary: Get scorecard template by ID
      description: >-
        Retrieve a single scorecard template by its UUID, including all criteria
        (active + archived).
      operationId: getScorecardTemplateById
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            description: Scorecard template ID
      responses:
        '200':
          description: Scorecard template found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScorecardTemplateByIdResponse'
              example:
                success: true
                data:
                  id: aaaa1111-2222-3333-4444-555555555555
                  name: Senior Backend Engineer Scorecard
                  description: Interview rubric for senior backend engineering candidates.
                  job_id: 456e7890-e12b-34d5-a678-901234567890
                  rating_scale: 5
                  enable_ai_auto_grade: false
                  is_archived: false
                  overall_default_text: >-
                    Summarize the candidate against the must-have criteria
                    first, then list any concerns.
                  created_by:
                    id: 567e8901-e23c-45d6-e789-012345678901
                    first_name: Jane
                    last_name: Smith
                  created_at: '2026-05-20T10:00:00Z'
                  updated_at: '2026-05-20T10:00:00Z'
                  criteria:
                    - id: bbbb1111-2222-3333-4444-555555555555
                      name: System design depth
                      description: >-
                        Can the candidate reason about consistency,
                        partitioning, and failure modes for a multi-region
                        service?
                      importance: must_have
                      position: 1
                      is_archived: false
                      default_text: >-
                        Note specific systems they have built, scale handled,
                        and trade-offs discussed.
                    - id: cccc1111-2222-3333-4444-555555555555
                      name: Async collaboration
                      description: Quality of written communication and decision logs.
                      importance: nice_to_have
                      position: 2
                      is_archived: false
                      default_text: null
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    ScorecardTemplateByIdResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/ScorecardTemplate'
      required:
        - success
        - data
    ScorecardTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Scorecard template UUID.
        name:
          type: string
          description: Template name shown to raters.
        description:
          type:
            - string
            - 'null'
          description: Optional template description.
        job_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Job UUID this template is scoped to. Null for org-wide templates.
            Only one active (non-archived) template can exist per job.
        rating_scale:
          type: integer
          description: 'Star rating scale. Must be one of: 3, 4, 5 (default), or 10.'
        enable_ai_auto_grade:
          type: boolean
          description: >-
            When true, the AI copilot can auto-grade candidates against this
            template.
        is_archived:
          type: boolean
          description: Archived templates are hidden from selection.
        overall_default_text:
          type:
            - string
            - 'null'
          description: >-
            Default note text pre-filled in the overall summary section when
            raters score with this template.
        created_by:
          allOf:
            - $ref: '#/components/schemas/ScorecardCreator'
            - type:
                - object
                - 'null'
              description: Team member who created the template.
        created_at:
          type: string
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          description: ISO 8601 last-updated timestamp.
        criteria:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardTemplateCriterion'
          description: >-
            Criteria attached to the template, sorted by position ascending.
            Includes archived criteria (use is_archived to filter).
      required:
        - id
        - name
        - description
        - job_id
        - rating_scale
        - enable_ai_auto_grade
        - is_archived
        - overall_default_text
        - created_by
        - created_at
        - updated_at
        - criteria
    ScorecardCreator:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Team member UUID.
        first_name:
          type:
            - string
            - 'null'
          description: First name.
        last_name:
          type:
            - string
            - 'null'
          description: Last name.
      required:
        - id
        - first_name
        - last_name
    ScorecardTemplateCriterion:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Criterion UUID.
        name:
          type: string
          description: Criterion display name.
        description:
          type:
            - string
            - 'null'
          description: Optional longer description shown to raters.
        importance:
          type: string
          enum:
            - must_have
            - nice_to_have
          description: 'Weighting: must_have or nice_to_have.'
        position:
          type: number
          description: Sort order. Lower values are displayed first.
        is_archived:
          type: boolean
          description: Archived criteria are hidden from the UI.
        default_text:
          type:
            - string
            - 'null'
          description: Default note text pre-filled when raters open this criterion.
      required:
        - id
        - name
        - description
        - importance
        - position
        - is_archived
        - default_text
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````