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

# List offerings

> Returns a paginated list of offerings



## OpenAPI

````yaml /openapi.generated.json get /api/v1/offerings
openapi: 3.0.3
info:
  title: Augment External API
  version: 1.0.0
  description: >
    Public, API-key-authenticated read surface for Augment company and offering
    data.
servers:
  - url: https://developer.augment.market
  - url: https://xxe4toqf29.execute-api.us-west-2.amazonaws.com/dev-ethan
security: []
paths:
  /api/v1/offerings:
    get:
      tags:
        - external-api-v1
      summary: List offerings
      description: Returns a paginated list of offerings
      operationId: listExternalApiOfferings
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - name: company_id
          in: query
          description: An array of company IDs by which to filter
          required: false
          schema:
            type: array
            items:
              type: integer
          style: form
          explode: true
      responses:
        '200':
          description: A paginated list of offerings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfferingList'
              example:
                offerings:
                  - public_id: off_9f8c2a
                    company_id: 42
                    description: Acme Robotics Series C secondary
                    status: OPEN
                    type: COMMITTED
                    acquisition_method: SECONDARY
                    management_fee: 2%
                    carry: 20%
                    investment_structure: SPV
                    estimated_valuation: '1200000000'
                    minimum_commitment_amount: 25000
                    created_at: '2025-01-01T00:00:00Z'
                    updated_at: '2025-01-15T12:00:00Z'
                page_info:
                  limit: 25
                  offset: 0
                  total_count: 1
                  has_next: false
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '401':
          $ref: '#/components/responses/ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/ErrorForbidden'
        '429':
          $ref: '#/components/responses/ErrorRateLimited'
        '500':
          $ref: '#/components/responses/ErrorInternalError'
        '503':
          $ref: '#/components/responses/ErrorServiceUnavailable'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Maximum number of elements to return
      required: false
      schema:
        type: integer
      example: 25
    Offset:
      name: offset
      in: query
      description: Number of elements to skip before collecting the result set
      required: false
      schema:
        type: integer
      example: 50
  schemas:
    OfferingList:
      type: object
      description: A paginated window of offerings
      properties:
        offerings:
          type: array
          items:
            $ref: '#/components/schemas/Offering'
        page_info:
          $ref: '#/components/schemas/PageInfo'
      required:
        - offerings
        - page_info
      additionalProperties: false
    Offering:
      type: object
      properties:
        public_id:
          type: string
          description: Public identifier of the offering
        company_id:
          type: integer
          description: Identifier of the company the offering is for
        description:
          type: string
          description: Description of the offering
        status:
          $ref: '#/components/schemas/OfferingStatus'
        type:
          $ref: '#/components/schemas/OfferingType'
        acquisition_method:
          $ref: '#/components/schemas/OfferingAcquisitionMethod'
        management_fee:
          type: string
          description: Management fee charged on the investment
        carry:
          type: string
          description: Carried interest charged on the investment
        investment_structure:
          type: string
          description: How the investment is structured
        estimated_valuation:
          type: string
          description: Estimated valuation the offering is priced against
        minimum_commitment_amount:
          type: number
          format: double
          description: Smallest commitment an investor may make
        closed_at:
          type: string
          format: date-time
          nullable: true
          description: When the offering closed, if it has closed
        created_at:
          type: string
          format: date-time
          description: When the offering was created
        updated_at:
          type: string
          format: date-time
          description: When the offering was last updated
      required:
        - public_id
        - company_id
        - description
        - status
        - type
        - acquisition_method
        - management_fee
        - carry
        - investment_structure
        - estimated_valuation
        - minimum_commitment_amount
        - created_at
        - updated_at
      additionalProperties: false
    PageInfo:
      type: object
      description: Pagination metadata describing the returned window of results
      properties:
        limit:
          type: integer
          format: int64
          description: Maximum number of elements returned
        offset:
          type: integer
          format: int64
          description: Number of elements skipped before this window
        total_count:
          type: integer
          format: int64
          description: Total number of elements matching the request
        has_next:
          type: boolean
          description: Whether a following window exists
      required:
        - limit
        - offset
        - total_count
        - has_next
      additionalProperties: false
      example:
        limit: 25
        offset: 50
        total_count: 137
        has_next: true
    ErrorEnvelope:
      type: object
      description: Error body returned by every failing response
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          $ref: '#/components/schemas/ErrorCode'
      required:
        - error
        - code
      additionalProperties: false
    OfferingStatus:
      type: string
      description: Lifecycle status of an offering
      enum:
        - COMING
        - OPEN
        - CLOSING
        - CLOSED
        - CANCELLED
        - ROFRED
    OfferingType:
      type: string
      description: How the offering is structured for investors
      enum:
        - WAREHOUSED
        - COMMITTED
        - OPPORTUNITY
    OfferingAcquisitionMethod:
      type: string
      description: Market the underlying shares are acquired through
      enum:
        - PRIMARY
        - SECONDARY
    ErrorCode:
      type: string
      description: >
        Machine-readable error code. Mirrors external/domain/errors.go exactly;
        the wire strings are part of the public contract and must not drift from
        that file.
      enum:
        - unauthenticated
        - invalid_key
        - key_revoked
        - insufficient_scope
        - client_suspended
        - not_found
        - invalid_parameter
        - rate_limited
        - service_unavailable
        - internal_error
  responses:
    ErrorBadRequest:
      description: Invalid request parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Invalid request parameter
            code: invalid_parameter
    ErrorUnauthorized:
      description: Missing, invalid, or revoked API credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Missing API credentials
            code: unauthenticated
    ErrorForbidden:
      description: The API key lacks the required scope, or the client is suspended
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: API key does not grant the required scope
            code: insufficient_scope
    ErrorRateLimited:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Too many requests, please try again later
            code: rate_limited
    ErrorInternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Internal server error
            code: internal_error
    ErrorServiceUnavailable:
      description: The service is temporarily unavailable; retry later
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Service temporarily unavailable, please try again later
            code: service_unavailable
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        The API key issued to your client. Send it on every request; a missing,
        unrecognised, or revoked key is rejected with 401.

````