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

# Your saved role preferences

> The role preferences saved on your Paraform profile: the same values the in-app profile page shows, and the ones `listRecruiterRoles` applies when you pass `matchMyPreferences`.

An empty array means nothing is saved for that preference, so `matchMyPreferences` adds no filter for it; `minSalary` null means no salary preference is saved. `minSalary` is the saved annual salary preference as a whole number; no currency is stored with it. `matchMyPreferences` applies it to the role salary-band filter, so matched roles are ones whose salary band reaches it, not roles whose minimum meets it. `description` is the recruiter's own free text, null when none was written.

These are stated preferences, not inferred ones. Paraform separately derives specialties from a recruiter's placement history, and those are not returned here.

This endpoint is read-only. Preferences are edited in the Paraform app.

Required scopes: `roles:read`.



## OpenAPI

````yaml /api/openapi.json get /recruiter/preferences
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /recruiter/preferences:
    get:
      summary: Your saved role preferences
      description: >-
        The role preferences saved on your Paraform profile: the same values the
        in-app profile page shows, and the ones `listRecruiterRoles` applies
        when you pass `matchMyPreferences`.


        An empty array means nothing is saved for that preference, so
        `matchMyPreferences` adds no filter for it; `minSalary` null means no
        salary preference is saved. `minSalary` is the saved annual salary
        preference as a whole number; no currency is stored with it.
        `matchMyPreferences` applies it to the role salary-band filter, so
        matched roles are ones whose salary band reaches it, not roles whose
        minimum meets it. `description` is the recruiter's own free text, null
        when none was written.


        These are stated preferences, not inferred ones. Paraform separately
        derives specialties from a recruiter's placement history, and those are
        not returned here.


        This endpoint is read-only. Preferences are edited in the Paraform app.


        Required scopes: `roles:read`.
      operationId: getRecruiterPreferences
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  roleTypes:
                    type: array
                    items:
                      type: string
                  locations:
                    type: array
                    items:
                      type: string
                  industries:
                    type: array
                    items:
                      type: string
                  workplaceTypes:
                    type: array
                    items:
                      type: string
                  fundingRounds:
                    type: array
                    items:
                      type: string
                  minSalary:
                    type: number
                    nullable: true
                  description:
                    type: string
                    nullable: true
                required:
                  - roleTypes
                  - locations
                  - industries
                  - workplaceTypes
                  - fundingRounds
                  - minSalary
                  - description
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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