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

# List opportunities

> Pages through opportunities in a stable order. Filter with `filter[<key>][<op>]=<value>` (conditions are ANDed; `in` and `nin` repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text `eq` ignores case, except on ids (`crm_opportunity_id`, `account`, `owner`), which match exactly. `in` and `nin` match exactly, but on `stage` and `type` they also match the other spelling of the same stage (its key or its label). Dates are YYYY-MM-DD and compare as whole days. `is_closed` and `is_won` take true or false; false also matches one not set. 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 get /v1/objects/opportunity/records
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:
    get:
      tags:
        - opportunities
      summary: List opportunities
      description: >-
        Pages through opportunities in a stable order. Filter with
        `filter[<key>][<op>]=<value>` (conditions are ANDed; `in` and `nin`
        repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin,
        contains, starts_with, exists, not_exists. Each field accepts a subset,
        and anything else is a 422 naming what that field supports. Text `eq`
        ignores case, except on ids (`crm_opportunity_id`, `account`, `owner`),
        which match exactly. `in` and `nin` match exactly, but on `stage` and
        `type` they also match the other spelling of the same stage (its key or
        its label). Dates are YYYY-MM-DD and compare as whole days. `is_closed`
        and `is_won` take true or false; false also matches one not set.
        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_list
      parameters:
        - description: >-
            Only the records this saved view or segment selects (GET /v1/views
            lists them); other filters narrow them further
          in: query
          name: view_id
          required: false
          schema:
            anyOf:
              - minimum: 1
                type: integer
              - type: 'null'
            default: null
        - description: >-
            Custom field keys to return (comma-separated); all of them when
            omitted
          explode: false
          in: query
          name: fields
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            default: null
          style: form
        - in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - description: '`next_cursor` from the previous page'
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
        - description: >-
            Filter with query parameters ``filter[<key>][<op>]=<value>``, all
            ANDed; ``in``

            and ``nin`` take the parameter repeated. Keys are those GET
            /v1/fields?object=opportunity lists.


            Operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`,
            `contains`, `not_contains`, `starts_with`, `ends_with`, `exists`,
            `not_exists`.
          explode: true
          in: query
          name: filter
          required: false
          schema:
            additionalProperties:
              additionalProperties: true
              type: object
            type: object
          style: deepObject
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityPage'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    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.