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

# Search opportunities with AND/OR filters

> Like listing, with the filter as a JSON tree: a condition `{"field", "op", "value"}` or a group `{"and": [...]}` / `{"or": [...]}`, at most 3 levels deep and 20 conditions. Standard fields sit at the top level and custom fields under `fields`, keyed as GET /v1/fields?object=opportunity lists them. `account` and `owner` hold the id of one record (an account, a user); `account_name` is the account's name. The account may since have been deleted: the opportunity still names it. `is_closed` and `is_won` are read-only (a synced opportunity carries your CRM's flags, and an edit to the stage in Statisfy sets them from that stage); one that is not set reads as false. `source` is where the opportunity came from: `statisfy`, your CRM's name, `crm` for a synced one with no name recorded, or `system` for a renewal Statisfy generated. Archived opportunities are never returned.



## OpenAPI

````yaml /api/statisfy-api.openapi.json post /v1/objects/opportunity/records/search
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/objects/opportunity/records/search:
    post:
      tags:
        - opportunities
      summary: Search opportunities with AND/OR filters
      description: >-
        Like listing, with the filter as a JSON tree: a condition `{"field",
        "op", "value"}` or a group `{"and": [...]}` / `{"or": [...]}`, at most 3
        levels deep and 20 conditions. Standard fields sit at the top level and
        custom fields under `fields`, keyed as GET /v1/fields?object=opportunity
        lists them. `account` and `owner` hold the id of one record (an account,
        a user); `account_name` is the account's name. The account may since
        have been deleted: the opportunity still names it. `is_closed` and
        `is_won` are read-only (a synced opportunity carries your CRM's flags,
        and an edit to the stage in Statisfy sets them from that stage); one
        that is not set reads as false. `source` is where the opportunity came
        from: `statisfy`, your CRM's name, `crm` for a synced one with no name
        recorded, or `system` for a renewal Statisfy generated. Archived
        opportunities are never returned.
      operationId: opportunities_search
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                cursor:
                  anyOf:
                    - type: string
                    - type: 'null'
                  default: null
                  description: '`next_cursor` from the previous page'
                  title: Cursor
                fields:
                  anyOf:
                    - items:
                        type: string
                      type: array
                    - type: 'null'
                  default: null
                  description: >-
                    Custom field keys to return (comma-separated); all of them
                    when omitted
                  title: Fields
                filter:
                  anyOf:
                    - $ref: '#/components/schemas/FilterCondition'
                    - $ref: '#/components/schemas/FilterGroup'
                    - type: 'null'
                  default: null
                  description: A condition, or an 'and'/'or' group of them
                  title: Filter
                limit:
                  default: 25
                  maximum: 100
                  minimum: 1
                  title: Limit
                  type: integer
                view_id:
                  anyOf:
                    - minimum: 1
                      type: integer
                    - type: 'null'
                  default: null
                  description: >-
                    Only the records this saved view or segment selects (GET
                    /v1/views lists them); other filters narrow them further
                  title: View Id
              type: object
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityPage'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    FilterCondition:
      additionalProperties: false
      properties:
        field:
          title: Field
          type: string
        op:
          enum:
            - eq
            - neq
            - gt
            - gte
            - lt
            - lte
            - in
            - nin
            - contains
            - not_contains
            - starts_with
            - ends_with
            - exists
            - not_exists
          title: Op
          type: string
        value:
          default: null
          title: Value
      required:
        - field
        - op
      title: FilterCondition
      type: object
    FilterGroup:
      additionalProperties: false
      properties:
        and:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/FilterCondition'
                  - $ref: '#/components/schemas/FilterGroup'
              type: array
            - type: 'null'
          default: null
          title: And
        or:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/FilterCondition'
                  - $ref: '#/components/schemas/FilterGroup'
              type: array
            - type: 'null'
          default: null
          title: Or
      title: FilterGroup
      type: object
    OpportunityPage:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Opportunity'
          title: Data
          type: array
        has_more:
          default: false
          title: Has More
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      required:
        - data
      title: OpportunityPage
      type: object
    Opportunity:
      properties:
        account:
          anyOf:
            - type: string
            - type: 'null'
          description: The id of the account the opportunity is on
          title: Account
        account_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Name
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
        close_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Close Date
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        crm_opportunity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Crm Opportunity Id
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        fields:
          additionalProperties: true
          title: Fields
          type: object
        id:
          title: Id
          type: string
        is_closed:
          default: false
          title: Is Closed
          type: boolean
        is_won:
          default: false
          title: Is Won
          type: boolean
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        owner:
          anyOf:
            - type: string
            - type: 'null'
          description: The owner's user id
          title: Owner
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
        stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Stage
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
      required:
        - id
      title: Opportunity
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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