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

# List the roles you are working on

> The active roles you are working on: every role where you hold a primary slot (including one on trial), plus every role where you have an active submission, meaning a candidate you submitted who is submitted, reviewed, interviewing, or at offer stage. Paused and closed roles are not listed. To find new roles to work on, use listRecruiterRoles; for a role's full detail, use getRecruiterRole.

`primaryOnly`, `activeTrialOnly`, `singleSubmissionsOnly` and `paraAiOnly` narrow the list. When several are true, a role matching ANY of them is returned. `activeTrialOnly` matches a trial still inside its window whose submission goal is not yet met. `singleSubmissionsOnly` and `paraAiOnly` match whether or not you also hold a primary slot on the role.

Ordered by the role's last update, newest first, then role ID. A page holds at most 100 roles, and can hold fewer roles than `limit`, or none, while `nextCursor` is set; continue until `nextCursor` is null.

`fee` is what the placement pays you, the same figures listRecruiterRoles returns. Amounts are in `baseSalary.currency`; a null currency means it is not recorded. When your agency hides payment from its members, every `fee` field is null; agency owners always see fees. `fee` itself is null when the role's fee cannot be read through this endpoint.

A confidential stealth role you are not assigned to shows as "Confidential (Stealth)", with the company name removed from its title and locations.

Required scopes: `roles:read`.



## OpenAPI

````yaml /api/openapi.json get /recruiter/active-roles
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /recruiter/active-roles:
    get:
      summary: List the roles you are working on
      description: >-
        The active roles you are working on: every role where you hold a primary
        slot (including one on trial), plus every role where you have an active
        submission, meaning a candidate you submitted who is submitted,
        reviewed, interviewing, or at offer stage. Paused and closed roles are
        not listed. To find new roles to work on, use listRecruiterRoles; for a
        role's full detail, use getRecruiterRole.


        `primaryOnly`, `activeTrialOnly`, `singleSubmissionsOnly` and
        `paraAiOnly` narrow the list. When several are true, a role matching ANY
        of them is returned. `activeTrialOnly` matches a trial still inside its
        window whose submission goal is not yet met. `singleSubmissionsOnly` and
        `paraAiOnly` match whether or not you also hold a primary slot on the
        role.


        Ordered by the role's last update, newest first, then role ID. A page
        holds at most 100 roles, and can hold fewer roles than `limit`, or none,
        while `nextCursor` is set; continue until `nextCursor` is null.


        `fee` is what the placement pays you, the same figures
        listRecruiterRoles returns. Amounts are in `baseSalary.currency`; a null
        currency means it is not recorded. When your agency hides payment from
        its members, every `fee` field is null; agency owners always see fees.
        `fee` itself is null when the role's fee cannot be read through this
        endpoint.


        A confidential stealth role you are not assigned to shows as
        "Confidential (Stealth)", with the company name removed from its title
        and locations.


        Required scopes: `roles:read`.
      operationId: listRecruiterActiveRoles
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles where you hold primary slot, trial included? `true` or
              `false`, default false.
          required: false
          description: >-
            Only roles where you hold primary slot, trial included? `true` or
            `false`, default false.
          name: primaryOnly
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only primary slots with trial still running (window open,
              submission goal not met)? `true` or `false`, default false.
          required: false
          description: >-
            Only primary slots with trial still running (window open, submission
            goal not met)? `true` or `false`, default false.
          name: activeTrialOnly
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles where you have active single submission? `true` or
              `false`, default false.
          required: false
          description: >-
            Only roles where you have active single submission? `true` or
            `false`, default false.
          name: singleSubmissionsOnly
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles where you have active submission from ParaAI match?
              `true` or `false`, default false.
          required: false
          description: >-
            Only roles where you have active submission from ParaAI match?
            `true` or `false`, default false.
          name: paraAiOnly
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
            description: Roles per page. Default 10; above 100 rejected.
          required: false
          description: Roles per page. Default 10; above 100 rejected.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 2048
            description: >-
              Previous page's `nextCursor`, unchanged, same filters. Omit for
              first page.
          required: false
          description: >-
            Previous page's `nextCursor`, unchanged, same filters. Omit for
            first page.
          name: cursor
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        company:
                          type: object
                          properties:
                            name:
                              type: string
                          required:
                            - name
                          additionalProperties: false
                        status:
                          type: string
                          enum:
                            - ACTIVE
                            - PAUSED
                            - CLOSED
                        locations:
                          type: array
                          items:
                            type: string
                        workplaceType:
                          type: string
                          nullable: true
                          enum:
                            - REMOTE
                            - HYBRID
                            - ON_SITE
                        baseSalary:
                          type: object
                          nullable: true
                          properties:
                            currency:
                              type: string
                              nullable: true
                            min:
                              type: integer
                              nullable: true
                            max:
                              type: integer
                              nullable: true
                          required:
                            - currency
                            - min
                            - max
                          additionalProperties: false
                          description: >-
                            Annual candidate base salary, whole currency units,
                            no conversion. Null currency means unknown, not USD.
                        updatedAt:
                          type: string
                          format: date-time
                        fee:
                          type: object
                          nullable: true
                          properties:
                            amountLowerBound:
                              type: number
                              nullable: true
                            percentOfSalary:
                              type: number
                              nullable: true
                            boostPercent:
                              type: number
                              nullable: true
                            bonusAmount:
                              type: number
                              nullable: true
                            firstSubmissionReward:
                              type: number
                              nullable: true
                          required:
                            - amountLowerBound
                            - percentOfSalary
                            - boostPercent
                            - bonusAmount
                            - firstSubmissionReward
                          description: >-
                            Null when role fee unreadable here. Every field null
                            when agency hides payment from members.
                      required:
                        - id
                        - title
                        - company
                        - status
                        - locations
                        - workplaceType
                        - baseSalary
                        - updatedAt
                        - fee
                      additionalProperties: false
                  nextCursor:
                    type: string
                    nullable: true
                required:
                  - roles
                  - nextCursor
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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