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

# List Transactions



## OpenAPI

````yaml /openapi/tms.json get /transactions
openapi: 3.0.3
info:
  title: Universal TMS API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://tms.universal.rollout.com/api
security: []
paths:
  /transactions:
    get:
      tags:
        - Transactions
      summary: List Transactions
      operationId: getTransactions
      parameters:
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
        - name: id
          in: query
          required: false
          schema:
            type: string
        - name: sourceId
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.gte
          in: query
          required: false
          schema:
            type: string
        - name: rolloutUpdated.lte
          in: query
          required: false
          schema:
            type: string
        - name: next
          in: query
          required: false
          schema:
            type: string
            description: >-
              Cursor of the page to return, from the previous page's
              `_metadata.next`. Can't be combined with `offset`.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            description: >-
              Number of records to skip, for offset paging. Defaults to 0. Can't
              be combined with `next`.
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            description: Records per page, capped at 100.
            type: number
        - name: fields
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated top-level fields to return; the parameter can also
              be repeated, once per field. `id` is always returned. Omit it, or
              pass `allFields`, to get every field, including `original`.
              Unknown names return 400.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    type: object
                    properties:
                      collection:
                        type: string
                        enum:
                          - transactions
                        description: The key of this response that holds the records.
                      offset:
                        type: number
                        description: >-
                          Number of records skipped before this page: the
                          `offset` requested, or 0 on a cursor page.
                      limit:
                        type: number
                        description: >-
                          Page size applied: the `limit` requested, capped at
                          100, or 10 by default.
                      total:
                        type: number
                        description: >-
                          Number of records matching the request, across all
                          pages.
                      next:
                        nullable: true
                        description: >-
                          Cursor of the next page, to pass as `next`; null on
                          the last page.
                        type: string
                      nextLink:
                        nullable: true
                        description: >-
                          URL of the next page, this request's with `next` set;
                          null on the last page.
                        type: string
                    required:
                      - collection
                      - offset
                      - limit
                      - total
                      - next
                      - nextLink
                    description: How this page relates to the whole collection.
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        originalIds:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          additionalProperties:
                            anyOf:
                              - type: number
                              - type: string
                        original:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          additionalProperties:
                            type: object
                            additionalProperties: {}
                        created:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        updated:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        rolloutUpdated:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        userParticipants:
                          description: Present unless the request's `fields` leaves it out.
                          type: array
                          items:
                            type: object
                            properties:
                              userId:
                                type: string
                              roles:
                                type: array
                                items:
                                  type: string
                              buySideCommissionAmount:
                                nullable: true
                                type: number
                              sellSideCommissionAmount:
                                nullable: true
                                type: number
                              totalCommissionAmount:
                                nullable: true
                                type: number
                            required:
                              - userId
                              - roles
                              - buySideCommissionAmount
                              - sellSideCommissionAmount
                              - totalCommissionAmount
                        peopleParticipants:
                          description: Present unless the request's `fields` leaves it out.
                          type: array
                          items:
                            type: object
                            properties:
                              personId:
                                type: string
                              roles:
                                type: array
                                items:
                                  type: string
                            required:
                              - personId
                              - roles
                        transactionName:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        titleCompany:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        mortgageCompany:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        transactionType:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        property:
                          description: Present unless the request's `fields` leaves it out.
                          type: object
                          properties:
                            address:
                              type: object
                              properties:
                                type:
                                  type: string
                                street:
                                  type: string
                                city:
                                  type: string
                                state:
                                  type: string
                                code:
                                  type: string
                                county:
                                  type: string
                                country:
                                  type: string
                              required:
                                - type
                                - street
                                - city
                                - state
                                - code
                                - country
                            yearBuilt:
                              type: number
                            mlsNumber:
                              type: string
                            price:
                              nullable: true
                              type: number
                          required:
                            - mlsNumber
                            - price
                        closingDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        escrowClosingDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        acceptanceDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        expirationDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        listingDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        status:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        stage:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        sideRepresented:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        totalCommissionRate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        totalCommissionAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        sellSideCommissionRate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        sellSideCommissionAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        buySideCommissionRate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        buySideCommissionAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        brokerageCommissionAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        teamCommissionAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        referralRate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        referralAmount:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        teamSplitPct:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: number
                        source:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        sourceId:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        clientRepAgreementSignedDate:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                        description:
                          description: Present unless the request's `fields` leaves it out.
                          type: string
                        officeId:
                          description: Present unless the request's `fields` leaves it out.
                          nullable: true
                          type: string
                      required:
                        - id
                    description: The records of this page, under the collection's name.
                required:
                  - _metadata
                  - transactions
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                    enum:
                      - >-
                        Data for this credential is not ready yet. Please try
                        again.
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

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