> ## 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.

# List person reference types

> List the reference types configured for your workspace (for example Colleague, Manager, Friend). Use the `type` key as `reference_type` when creating or updating a reference.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/persons/reference-types
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.
  - name: Campaigns
    description: >-
      Create and edit email campaigns, enroll people through enrollment batches,
      and manage who is enrolled.
paths:
  /v1/persons/reference-types:
    get:
      tags:
        - Persons
      summary: List person reference types
      description: >-
        List the reference types configured for your workspace (for example
        Colleague, Manager, Friend). Use the `type` key as `reference_type` when
        creating or updating a reference.
      operationId: listPersonReferenceTypes
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
              - type: string
                enum:
                  - 'false'
              - type: boolean
            description: >-
              When true, also return archived reference types. Archived types
              cannot be used for new references but may still appear on existing
              ones.
          required: false
          name: include_archived
          in: query
      responses:
        '200':
          description: Reference types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonReferenceTypesResponse'
              example:
                success: true
                data:
                  - type: colleague
                    name: Colleague
                    is_archived: false
                  - type: manager
                    name: Manager
                    is_archived: false
                  - type: previous_manager
                    name: Previous Manager
                    is_archived: false
        '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:
    PersonReferenceTypesResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/PersonReferenceType'
      required:
        - success
        - data
    PersonReferenceType:
      type: object
      properties:
        type:
          type: string
          description: Reference type key. Pass this as `reference_type`.
        name:
          type: string
          description: Display name shown in the app.
        is_archived:
          type: boolean
          description: >-
            Archived types cannot be used for new references but may still
            appear on existing ones.
      required:
        - type
        - name
        - is_archived
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.