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

# Get Opportunities



## OpenAPI

````yaml /actionkit/openapi.json POST /projects/{project_id}/tools/#OUTREACH_GET_OPPORTUNITIES
openapi: 3.0.0
info:
  title: ActionKit Tools API
  version: 1.0.0
servers:
  - url: https://actionkit.useparagon.com
    description: US Cloud
security: []
paths:
  /projects/{project_id}/tools/#OUTREACH_GET_OPPORTUNITIES:
    post:
      summary: Get Opportunities
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              Your Paragon Project ID. You can copy your Project ID from your
              dashboard URL or by clicking Copy Project ID under the Environment
              switcher.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tool:
                  type: string
                  default: OUTREACH_GET_OPPORTUNITIES
                parameters:
                  type: object
                  properties:
                    opportunityFilterFormula:
                      type: object
                      description: >-
                        A filter in disjunctive normal form: OR of AND groups of
                        single conditions
                      properties:
                        operator:
                          type: string
                          description: Top-level operator must be OR (DNF enforced)
                          enum:
                            - OR
                        conditions:
                          type: array
                          description: >-
                            Each item is an AND group (a conjunction of single
                            conditions)
                          items:
                            type: object
                            properties:
                              operator:
                                type: string
                                description: Each group is an AND of single conditions
                                enum:
                                  - AND
                              conditions:
                                type: array
                                description: List of single conditions (AND together)
                                items:
                                  type: object
                                  properties:
                                    field:
                                      type: string
                                      enum:
                                        - probability
                                        - riskScore
                                        - name
                                        - mapStatus
                                        - createdAt
                                        - updatedAt
                                    operator:
                                      type: string
                                      enum:
                                        - $stringExactlyMatches
                                        - $numberEquals
                                        - $numberGreaterThan
                                        - $numberLessThan
                                        - $numberGreaterThanOrEqualTo
                                        - $numberLessThanOrEqualTo
                                        - $dateTimeEquals
                                        - $dateTimeBefore
                                        - $dateTimeAfter
                                    value:
                                      type: string
                                      description: Value to compare against
                                  required:
                                    - field
                                    - operator
                                    - value
                            required:
                              - operator
                              - conditions
                      required:
                        - operator
                        - conditions
                    paginationParameters:
                      type: object
                      description: Pagination Parameters
                      properties:
                        pageSize:
                          type: number
                          description: Page size to fetch records default is 100
                        pageCursor:
                          type: string
                          description: >-
                            Page cursor to fetch records. Use the page[after]
                            value from the previous response to fetch the next
                            page of records. Example:
                            "eyJjbiI6IkFwaVYyOjpQcm9zcGVjdHNDb250cm9sbGVyIiwic3AiOm51bGwsInN2IjpbXSwiaWQiOjEwMiwidiI6MX0%3D"
                  x-integration: outreach
              required:
                - tool
                - parameters
      responses:
        '200':
          description: Success
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Your [Paragon User
        Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which
        you can generate using your project's signing keys.

````