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

# Browse roles you can work on

> The roles the calling recruiter can see on Paraform, the same set and the same ordering as the in-app Browse page.

Every filter is optional and they combine with AND. Array filters match ANY of the values given; pass a filter more than once to send several values. `query` is a full-text search over the role and company that tolerates typos. `minSalary` and `maxSalary` are whole numbers of annual salary, compared to each role's salary band as stored, with no currency conversion, and matched to the nearest 1,000. A bound above 999,000 is read as 999,000. `compensation.salaryLowerBound`, `salaryUpperBound` and `fee.amountLowerBound` are in `compensation.currency` when it is set; when it is null the currency is not recorded, so it is not necessarily dollars.

`location`, `roleType`, `workplace`, `talentDensity`, `industry` and `visaSponsorship` match ONLY the keys listed in this schema (for example `san_francisco`, `product_management`, `ON_SITE`). Any other value, such as a typo or a display name like "San Francisco", is ignored, and a filter left with no known values does not filter.

`primaryOnly` narrows to roles where you hold a primary slot: the roles you are working on. `approvedOnly` narrows to every role where your approval is APPROVED at any access level, primary or not; it is not a list of roles you can submit any candidate to. Both are much cheaper than paging the whole board and reading `myRole`. `investors` matches investor names as substrings, ignoring case, so `Y Combinator` and `combinator` both work.

Set `matchMyPreferences` to true to fold in the role types, locations, industries, funding rounds and minimum salary saved on your Paraform profile; read them with `getRecruiterPreferences`. Within one field the saved values are ADDED to the values you send, across fields the filters still combine with AND, and the salary floor is the higher of the two. The search drops a `maxSalary` below that floor, so the ceiling does not apply. To get only your preferences send this flag and no other filters.

Each role carries `fee` (what the placement pays), `pipeline` (competition across all recruiters), `recruiterAccess` (how crowded the role is), `hiringManager` (rating, responsiveness, recency) and `myRole` (your approval, whether you are primary, and your own submission counts). `fee.percentOfSalary` is the rate offered to you and `fee.amountLowerBound` is that rate at the bottom of the salary band. When your agency hides payment from its members, every `fee` amount is null.

`myRole.isApproved` is `approvalStatus` equal to APPROVED. `myRole.isPrimary` is that plus `accessLevel` FULL: you hold a primary slot and submit through the normal path. APPROVED with `accessLevel` CROSS_SUBMIT is single-submission access: no primary slot, and whether a given candidate can go through is decided per candidate, so this flag alone does not mean you can submit. SUBMISSION_REQUEST_ONLY means only candidates a hiring manager specifically requested. `approvalStatus` null or anything other than APPROVED (PENDING, REJECTED, WITHDRAWN and so on) means you are not on the role; `urls.recruit` is null in that case.

`recruiterAccess.density` is `low`, `medium` or `high`: how much recruiter competition the role already has, the same tier the Browse page labels. Exact recruiter counts are not published. `atMaxCapacity` true means the role's count of pending, unreviewed submissions has reached Paraform's backlog threshold; it does not say whether you can submit. `notAcceptingRecruiters` true means the role does not let recruiters join by themselves and you are not on it, so you cannot self-serve onto it right now.

`hiringManager.responsivenessDays` is a weighted average of response times in days; a metric with no data counts as 0, so a very low value can mean little history rather than a fast hiring manager. `hiringManager.engagement.finalRating` runs 3.5 to 5.0 and `percentileRank` 0 to 100 against other hiring managers; both are null until the role has enough submissions to rate.

`myRole.trial` is set on a primary slot that is on trial. `isActive` true means the goal is not yet met inside the window; `endingSoon` true means the slot is about to be withdrawn. To find slots about to be lost, request `primaryOnly` and keep every role whose `trial.isActive` is true, sorted by `businessDaysLeft`. `submissionGoal` and `submissionsCounted` are the trial target and your progress toward it, `endsAt` the deadline, and `businessDaysLeft` the same countdown the app shows. The response keeps the Browse order.

PAGING: one response is ONE page of at most 20 roles, not the whole board. `nextCursor` present means more roles match; absent means this page was the last. `cursor` is a position inside the result list for one exact set of filters. When anything about the search changes (a different `query`, a filter added, removed or changed), start a NEW search with no `cursor`; reusing a cursor from a different search does not fail, it silently skips rows. An empty `roles` array on a fresh first page (no `cursor`) means nothing matched those filters, not that no roles exist. An empty page reached with a `cursor` only means there are no more rows at that position.

Each row is a summary. `getRecruiterRole` with the row's `id` returns the description, requirements, hiring manager questions, interview stages and recruiting advice.

Roles nobody can self-serve onto, and roles whose hiring manager has stopped reviewing, are left out, matching the in-app Browse page.

`urls.recruit` links to the role on Paraform, and `urls.browse` does when recruit is null. Paraform URLs are not guaranteed to be derivable from an id.

Required scopes: `roles:read`.



## OpenAPI

````yaml /api/openapi.json get /recruiter/roles
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /recruiter/roles:
    get:
      summary: Browse roles you can work on
      description: >-
        The roles the calling recruiter can see on Paraform, the same set and
        the same ordering as the in-app Browse page.


        Every filter is optional and they combine with AND. Array filters match
        ANY of the values given; pass a filter more than once to send several
        values. `query` is a full-text search over the role and company that
        tolerates typos. `minSalary` and `maxSalary` are whole numbers of annual
        salary, compared to each role's salary band as stored, with no currency
        conversion, and matched to the nearest 1,000. A bound above 999,000 is
        read as 999,000. `compensation.salaryLowerBound`, `salaryUpperBound` and
        `fee.amountLowerBound` are in `compensation.currency` when it is set;
        when it is null the currency is not recorded, so it is not necessarily
        dollars.


        `location`, `roleType`, `workplace`, `talentDensity`, `industry` and
        `visaSponsorship` match ONLY the keys listed in this schema (for example
        `san_francisco`, `product_management`, `ON_SITE`). Any other value, such
        as a typo or a display name like "San Francisco", is ignored, and a
        filter left with no known values does not filter.


        `primaryOnly` narrows to roles where you hold a primary slot: the roles
        you are working on. `approvedOnly` narrows to every role where your
        approval is APPROVED at any access level, primary or not; it is not a
        list of roles you can submit any candidate to. Both are much cheaper
        than paging the whole board and reading `myRole`. `investors` matches
        investor names as substrings, ignoring case, so `Y Combinator` and
        `combinator` both work.


        Set `matchMyPreferences` to true to fold in the role types, locations,
        industries, funding rounds and minimum salary saved on your Paraform
        profile; read them with `getRecruiterPreferences`. Within one field the
        saved values are ADDED to the values you send, across fields the filters
        still combine with AND, and the salary floor is the higher of the two.
        The search drops a `maxSalary` below that floor, so the ceiling does not
        apply. To get only your preferences send this flag and no other filters.


        Each role carries `fee` (what the placement pays), `pipeline`
        (competition across all recruiters), `recruiterAccess` (how crowded the
        role is), `hiringManager` (rating, responsiveness, recency) and `myRole`
        (your approval, whether you are primary, and your own submission
        counts). `fee.percentOfSalary` is the rate offered to you and
        `fee.amountLowerBound` is that rate at the bottom of the salary band.
        When your agency hides payment from its members, every `fee` amount is
        null.


        `myRole.isApproved` is `approvalStatus` equal to APPROVED.
        `myRole.isPrimary` is that plus `accessLevel` FULL: you hold a primary
        slot and submit through the normal path. APPROVED with `accessLevel`
        CROSS_SUBMIT is single-submission access: no primary slot, and whether a
        given candidate can go through is decided per candidate, so this flag
        alone does not mean you can submit. SUBMISSION_REQUEST_ONLY means only
        candidates a hiring manager specifically requested. `approvalStatus`
        null or anything other than APPROVED (PENDING, REJECTED, WITHDRAWN and
        so on) means you are not on the role; `urls.recruit` is null in that
        case.


        `recruiterAccess.density` is `low`, `medium` or `high`: how much
        recruiter competition the role already has, the same tier the Browse
        page labels. Exact recruiter counts are not published. `atMaxCapacity`
        true means the role's count of pending, unreviewed submissions has
        reached Paraform's backlog threshold; it does not say whether you can
        submit. `notAcceptingRecruiters` true means the role does not let
        recruiters join by themselves and you are not on it, so you cannot
        self-serve onto it right now.


        `hiringManager.responsivenessDays` is a weighted average of response
        times in days; a metric with no data counts as 0, so a very low value
        can mean little history rather than a fast hiring manager.
        `hiringManager.engagement.finalRating` runs 3.5 to 5.0 and
        `percentileRank` 0 to 100 against other hiring managers; both are null
        until the role has enough submissions to rate.


        `myRole.trial` is set on a primary slot that is on trial. `isActive`
        true means the goal is not yet met inside the window; `endingSoon` true
        means the slot is about to be withdrawn. To find slots about to be lost,
        request `primaryOnly` and keep every role whose `trial.isActive` is
        true, sorted by `businessDaysLeft`. `submissionGoal` and
        `submissionsCounted` are the trial target and your progress toward it,
        `endsAt` the deadline, and `businessDaysLeft` the same countdown the app
        shows. The response keeps the Browse order.


        PAGING: one response is ONE page of at most 20 roles, not the whole
        board. `nextCursor` present means more roles match; absent means this
        page was the last. `cursor` is a position inside the result list for one
        exact set of filters. When anything about the search changes (a
        different `query`, a filter added, removed or changed), start a NEW
        search with no `cursor`; reusing a cursor from a different search does
        not fail, it silently skips rows. An empty `roles` array on a fresh
        first page (no `cursor`) means nothing matched those filters, not that
        no roles exist. An empty page reached with a `cursor` only means there
        are no more rows at that position.


        Each row is a summary. `getRecruiterRole` with the row's `id` returns
        the description, requirements, hiring manager questions, interview
        stages and recruiting advice.


        Roles nobody can self-serve onto, and roles whose hiring manager has
        stopped reviewing, are left out, matching the in-app Browse page.


        `urls.recruit` links to the role on Paraform, and `urls.browse` does
        when recruit is null. Paraform URLs are not guaranteed to be derivable
        from an id.


        Required scopes: `roles:read`.
      operationId: listRecruiterRoles
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              Typo-tolerant full-text search over role and company, e.g. "staff
              backend engineer". Omit to browse.
          required: false
          description: >-
            Typo-tolerant full-text search over role and company, e.g. "staff
            backend engineer". Omit to browse.
          name: query
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
            description: >-
              Previous page's `nextCursor`, unchanged, same filters. Omit for
              first page. Cursor from another search does not fail; it silently
              skips rows.
          required: false
          description: >-
            Previous page's `nextCursor`, unchanged, same filters. Omit for
            first page. Cursor from another search does not fail; it silently
            skips rows.
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            default: 10
            description: Roles per page. Default 10; above 20 lowered to 20.
          required: false
          description: Roles per page. Default 10; above 20 lowered to 20.
          name: limit
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - new_york
                  - san_francisco
                  - south_bay_area
                  - los_angeles
                  - boston
                  - seattle
                  - texas
                  - chicago
                  - europe
                  - latam
                  - korea
                  - canada
                  - australia
                  - india
                  - uk
                  - washington_dc
                  - asia
                  - denver
                  - florida
                  - minnesota
                  - sacramento
              - type: array
                items:
                  type: string
                  enum:
                    - new_york
                    - san_francisco
                    - south_bay_area
                    - los_angeles
                    - boston
                    - seattle
                    - texas
                    - chicago
                    - europe
                    - latam
                    - korea
                    - canada
                    - australia
                    - india
                    - uk
                    - washington_dc
                    - asia
                    - denver
                    - florida
                    - minnesota
                    - sacramento
              - nullable: true
            description: Location keys, e.g. `san_francisco`. Matches ANY.
          required: false
          description: Location keys, e.g. `san_francisco`. Matches ANY.
          name: location
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - REMOTE
                  - ON_SITE
                  - HYBRID
              - type: array
                items:
                  type: string
                  enum:
                    - REMOTE
                    - ON_SITE
                    - HYBRID
              - nullable: true
            description: Workplace types, e.g. `REMOTE`. Matches ANY.
          required: false
          description: Workplace types, e.g. `REMOTE`. Matches ANY.
          name: workplace
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - backend_engineer
                  - frontend_engineer
                  - full_stack_engineer
                  - mobile_engineer
                  - infrastructure_devops_sre
                  - security_engineer
                  - forward_deployed_engineer_solutions_support
                  - robotics_software_engineer
                  - robotics_platform_engineer
                  - sales_solutions_engineer
                  - qa_test_engineering
                  - blockchain_protocol_engineer
                  - developer_relations_advocacy
                  - founding_engineer
                  - product_engineer
                  - embedded_firmware_engineer
                  - mechanical_engineer
                  - electrical_engineer
                  - robotics_hardware_engineer
                  - aerospace_flight_engineer
                  - machine_learning_engineer
                  - robotics_ml_engineer
                  - data_engineer
                  - data_science_analytics
                  - computer_vision_engineer
                  - research_scientist_applied_research
                  - ai_ml_researcher
                  - research_engineer_applied_research
                  - data_scientist_applied_scientist
                  - machine_learning_infrastructure
                  - machine_learning_ops_platform
                  - research_scientist
                  - research_engineer
                  - ai_engineer
                  - product_management
                  - product_design_ux_ui
                  - brand_visual_design
                  - marketing_growth
                  - growth_engineer
                  - growth_marketing
                  - demand_generation
                  - performance_paid_media
                  - lifecycle_crm_email
                  - seo_organic_growth
                  - marketing_ops_analytics
                  - product_marketing
                  - customer_marketing
                  - content_marketing
                  - brand_marketing
                  - social_media_influencer
                  - communications_pr
                  - events_field_marketing
                  - marketing_leadership
                  - founding_marketer_generalist
                  - account_executives_sales
                  - account_management_customer_success
                  - business_development
                  - sales_development_rep
                  - customer_technical_support
                  - content_copywriting
                  - sales_gtm_leadership
                  - partnerships
                  - operations_strategy
                  - robotics_operations_engineer
                  - revenue_operations
                  - finance_accounting
                  - people_talent
                  - chief_of_staff
                  - program_project_management
                  - executive_assistant
                  - data_analyst
                  - engineering_leadership
                  - executive_leadership
                  - clinical_healthcare
                  - legal_compliance_officer
                  - legal_operations
                  - legal_compliance
                  - legal_partner
                  - legal_counsel
                  - legal_associate
                  - legal_in_house_counsel
                  - legal_paralegal
                  - legal_admin
              - type: array
                items:
                  type: string
                  enum:
                    - backend_engineer
                    - frontend_engineer
                    - full_stack_engineer
                    - mobile_engineer
                    - infrastructure_devops_sre
                    - security_engineer
                    - forward_deployed_engineer_solutions_support
                    - robotics_software_engineer
                    - robotics_platform_engineer
                    - sales_solutions_engineer
                    - qa_test_engineering
                    - blockchain_protocol_engineer
                    - developer_relations_advocacy
                    - founding_engineer
                    - product_engineer
                    - embedded_firmware_engineer
                    - mechanical_engineer
                    - electrical_engineer
                    - robotics_hardware_engineer
                    - aerospace_flight_engineer
                    - machine_learning_engineer
                    - robotics_ml_engineer
                    - data_engineer
                    - data_science_analytics
                    - computer_vision_engineer
                    - research_scientist_applied_research
                    - ai_ml_researcher
                    - research_engineer_applied_research
                    - data_scientist_applied_scientist
                    - machine_learning_infrastructure
                    - machine_learning_ops_platform
                    - research_scientist
                    - research_engineer
                    - ai_engineer
                    - product_management
                    - product_design_ux_ui
                    - brand_visual_design
                    - marketing_growth
                    - growth_engineer
                    - growth_marketing
                    - demand_generation
                    - performance_paid_media
                    - lifecycle_crm_email
                    - seo_organic_growth
                    - marketing_ops_analytics
                    - product_marketing
                    - customer_marketing
                    - content_marketing
                    - brand_marketing
                    - social_media_influencer
                    - communications_pr
                    - events_field_marketing
                    - marketing_leadership
                    - founding_marketer_generalist
                    - account_executives_sales
                    - account_management_customer_success
                    - business_development
                    - sales_development_rep
                    - customer_technical_support
                    - content_copywriting
                    - sales_gtm_leadership
                    - partnerships
                    - operations_strategy
                    - robotics_operations_engineer
                    - revenue_operations
                    - finance_accounting
                    - people_talent
                    - chief_of_staff
                    - program_project_management
                    - executive_assistant
                    - data_analyst
                    - engineering_leadership
                    - executive_leadership
                    - clinical_healthcare
                    - legal_compliance_officer
                    - legal_operations
                    - legal_compliance
                    - legal_partner
                    - legal_counsel
                    - legal_associate
                    - legal_in_house_counsel
                    - legal_paralegal
                    - legal_admin
              - nullable: true
            description: Role type keys, e.g. `product_management`. Matches ANY.
          required: false
          description: Role type keys, e.g. `product_management`. Matches ANY.
          name: roleType
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Industry keys, matching ANY: venture_capital, logistics,
              real_estate, marketplace, healthcare, life_sciences, hardware, ai,
              gaming, fintech, finance, education, ecommerce, devtools, defense,
              cybersecurity, crypto, data, enterprise, financial_services,
              government, insurance, law, marketing, media, transportation,
              environment, robotics, security, construction, manufacturing,
              consumer, ad_tech, b2b, api_sdk, software_development,
              creator_economy, edtech, autonomous_vehicles, or
              <industry>::<practice_area> for legal practice area. Other values
              dropped.
          required: false
          description: >-
            Industry keys, matching ANY: venture_capital, logistics,
            real_estate, marketplace, healthcare, life_sciences, hardware, ai,
            gaming, fintech, finance, education, ecommerce, devtools, defense,
            cybersecurity, crypto, data, enterprise, financial_services,
            government, insurance, law, marketing, media, transportation,
            environment, robotics, security, construction, manufacturing,
            consumer, ad_tech, b2b, api_sdk, software_development,
            creator_economy, edtech, autonomous_vehicles, or
            <industry>::<practice_area> for legal practice area. Other values
            dropped.
          name: industry
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: Lowercase tech stack keys, e.g. `python` or `react`. Matches ANY.
          required: false
          description: Lowercase tech stack keys, e.g. `python` or `react`. Matches ANY.
          name: techStack
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - S_PLUS
                  - S
                  - A
                  - B
                  - C
              - type: array
                items:
                  type: string
                  enum:
                    - S_PLUS
                    - S
                    - A
                    - B
                    - C
              - nullable: true
            description: >-
              Employer talent tier, `S_PLUS` (highest) to `C`. Matches ANY;
              untiered roles dropped.
          required: false
          description: >-
            Employer talent tier, `S_PLUS` (highest) to `C`. Matches ANY;
            untiered roles dropped.
          name: talentDensity
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: >-
              Whole annual salary, e.g. 150000, in role's own currency (no
              conversion), rounded down to nearest 1,000. Matches roles whose
              band reaches it; above 999,000 read as 999,000.
          required: false
          description: >-
            Whole annual salary, e.g. 150000, in role's own currency (no
            conversion), rounded down to nearest 1,000. Matches roles whose band
            reaches it; above 999,000 read as 999,000.
          name: minSalary
          in: query
        - schema:
            type: integer
            minimum: 1
            description: >-
              Whole annual salary, e.g. 250000, in role's own currency, rounded
              up to nearest 1,000. Above 999,000 read as 999,000.
          required: false
          description: >-
            Whole annual salary, e.g. 250000, in role's own currency, rounded up
            to nearest 1,000. Above 999,000 read as 999,000.
          name: maxSalary
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: Whole years, e.g. 5. Matches overlapping experience range.
          required: false
          description: Whole years, e.g. 5. Matches overlapping experience range.
          name: minYearsExperience
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: Whole years, e.g. 8. Matches overlapping experience range.
          required: false
          description: Whole years, e.g. 8. Matches overlapping experience range.
          name: maxYearsExperience
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Add saved role types, locations, workplace types, industries,
              funding rounds and minimum salary to values sent? `true` or
              `false`, default false. Salary floor becomes higher of two; lower
              `maxSalary` ignored. Send alone to search by preferences only.
          required: false
          description: >-
            Add saved role types, locations, workplace types, industries,
            funding rounds and minimum salary to values sent? `true` or `false`,
            default false. Salary floor becomes higher of two; lower `maxSalary`
            ignored. Send alone to search by preferences only.
          name: matchMyPreferences
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles with at least one candidate interviewing now? `true` or
              `false`, default false.
          required: false
          description: >-
            Only roles with at least one candidate interviewing now? `true` or
            `false`, default false.
          name: currentlyInterviewing
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles you are approved on, any access level? `true` or
              `false`, default false. Approval does not mean any candidate can
              be submitted.
          required: false
          description: >-
            Only roles you are approved on, any access level? `true` or `false`,
            default false. Approval does not mean any candidate can be
            submitted.
          name: approvedOnly
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - 'true'
                  - 'false'
              - type: boolean
            description: >-
              Only roles where you hold primary slot? `true` or `false`, default
              false. Wins over `approvedOnly`.
          required: false
          description: >-
            Only roles where you hold primary slot? `true` or `false`, default
            false. Wins over `approvedOnly`.
          name: primaryOnly
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Investor names, case-insensitive substrings, e.g. `combinator`
              matches Y Combinator. Matches ANY.
          required: false
          description: >-
            Investor names, case-insensitive substrings, e.g. `combinator`
            matches Y Combinator. Matches ANY.
          name: investors
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Normalized role titles, exact, e.g. `Backend Engineer`. Matches
              ANY. Free text: use `query`.
          required: false
          description: >-
            Normalized role titles, exact, e.g. `Backend Engineer`. Matches ANY.
            Free text: use `query`.
          name: roleTitles
          in: query
        - schema:
            type: string
            nullable: true
            enum:
              - available
              - not_available
            description: >-
              `available`: only roles sponsoring new visa. `not_available`: only
              roles that do not. Omit for both.
          required: false
          description: >-
            `available`: only roles sponsoring new visa. `not_available`: only
            roles that do not. Omit for both.
          name: visaSponsorship
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
            description: >-
              Min hiring-manager engagement rating, 0 to 5, e.g. 4. Unrated
              roles (under four applications) dropped.
          required: false
          description: >-
            Min hiring-manager engagement rating, 0 to 5, e.g. 4. Unrated roles
            (under four applications) dropped.
          name: minHiringManagerRating
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
            description: >-
              Max days company typically takes to respond, mostly to new
              submissions, e.g. 2.5.
          required: false
          description: >-
            Max days company typically takes to respond, mostly to new
            submissions, e.g. 2.5.
          name: maxResponsivenessDays
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: Min candidates interviewing now, e.g. 1.
          required: false
          description: Min candidates interviewing now, e.g. 1.
          name: minActiveInterviews
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: >-
              Max candidates interviewing now, e.g. 3; 0 finds roles nobody
              interviewing for.
          required: false
          description: >-
            Max candidates interviewing now, e.g. 3; 0 finds roles nobody
            interviewing for.
          name: maxActiveInterviews
          in: query
        - schema:
            type: integer
            minimum: 1
            description: >-
              Whole days, e.g. 7: only roles posted in that window. Roles with
              no posting date dropped.
          required: false
          description: >-
            Whole days, e.g. 7: only roles posted in that window. Roles with no
            posting date dropped.
          name: postedWithinDays
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        postedAt:
                          type: string
                          nullable: true
                        urls:
                          type: object
                          properties:
                            browse:
                              type: string
                            recruit:
                              type: string
                              nullable: true
                          required:
                            - browse
                            - recruit
                        company:
                          type: object
                          properties:
                            name:
                              type: string
                            confidentialSearch:
                              type: boolean
                            anonymizedName:
                              type: string
                              nullable: true
                            oneLiner:
                              type: string
                              nullable: true
                            industries:
                              type: array
                              items:
                                type: string
                            size:
                              type: number
                              nullable: true
                          required:
                            - name
                            - confidentialSearch
                            - anonymizedName
                            - oneLiner
                            - industries
                            - size
                        locations:
                          type: array
                          items:
                            type: string
                        workplaceType:
                          type: string
                          nullable: true
                        roleTypes:
                          type: array
                          items:
                            type: string
                        techStack:
                          type: array
                          items:
                            type: string
                        visaText:
                          type: string
                          nullable: true
                        compensation:
                          type: object
                          properties:
                            salaryLowerBound:
                              type: number
                            salaryUpperBound:
                              type: number
                            currency:
                              type: string
                              nullable: true
                            equity:
                              type: string
                              nullable: true
                          required:
                            - salaryLowerBound
                            - salaryUpperBound
                            - currency
                            - equity
                        experience:
                          type: object
                          properties:
                            yearsMin:
                              type: number
                            yearsMax:
                              type: number
                              nullable: true
                          required:
                            - yearsMin
                            - yearsMax
                        fee:
                          type: object
                          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
                        pipeline:
                          type: object
                          properties:
                            totalApplications:
                              type: number
                              nullable: true
                            totalInterviewing:
                              type: number
                            totalHired:
                              type: number
                            openingsText:
                              type: string
                          required:
                            - totalApplications
                            - totalInterviewing
                            - totalHired
                            - openingsText
                        myRole:
                          type: object
                          properties:
                            isApproved:
                              type: boolean
                            isPrimary:
                              type: boolean
                            accessLevel:
                              type: string
                              nullable: true
                            approvalStatus:
                              type: string
                              nullable: true
                            submissions:
                              type: object
                              properties:
                                submitted:
                                  type: number
                                interviewing:
                                  type: number
                                hired:
                                  type: number
                                total:
                                  type: number
                              required:
                                - submitted
                                - interviewing
                                - hired
                                - total
                            trial:
                              type: object
                              nullable: true
                              properties:
                                endsAt:
                                  type: string
                                  nullable: true
                                businessDaysLeft:
                                  type: number
                                  nullable: true
                                submissionGoal:
                                  type: number
                                submissionsCounted:
                                  type: number
                                isActive:
                                  type: boolean
                                endingSoon:
                                  type: boolean
                              required:
                                - endsAt
                                - businessDaysLeft
                                - submissionGoal
                                - submissionsCounted
                                - isActive
                                - endingSoon
                          required:
                            - isApproved
                            - isPrimary
                            - accessLevel
                            - approvalStatus
                            - submissions
                            - trial
                        recruiterAccess:
                          type: object
                          properties:
                            atMaxCapacity:
                              type: boolean
                            notAcceptingRecruiters:
                              type: boolean
                            density:
                              type: string
                              nullable: true
                          required:
                            - atMaxCapacity
                            - notAcceptingRecruiters
                            - density
                        hiringManager:
                          type: object
                          properties:
                            lastActiveAt:
                              type: string
                              nullable: true
                            responsivenessDays:
                              type: number
                            engagement:
                              type: object
                              nullable: true
                              properties:
                                finalRating:
                                  type: number
                                  nullable: true
                                percentileRank:
                                  type: number
                                  nullable: true
                              required:
                                - finalRating
                                - percentileRank
                          required:
                            - lastActiveAt
                            - responsivenessDays
                            - engagement
                      required:
                        - id
                        - name
                        - postedAt
                        - urls
                        - company
                        - locations
                        - workplaceType
                        - roleTypes
                        - techStack
                        - visaText
                        - compensation
                        - experience
                        - fee
                        - pipeline
                        - myRole
                        - recruiterAccess
                        - hiringManager
                  nextCursor:
                    type: number
                required:
                  - roles
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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