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

# Get offering



## OpenAPI

````yaml /openapi/2026-07-02.yaml get /_api/offerings/{offeringId}
openapi: 3.0.3
info:
  title: Simply Tokenized API
  description: >-
    Simply Tokenized API for integrators and partners.


    **Current version `2026-07-02` is in beta** and is only available on the
    **development** environment (`https://dev.go.simplytokenized.com/_api`).
    Request and response shapes may change before a stable release. Beta
    responses include `ST-Api-Version-Beta: true`.


    | Environment | Base URL |

    |-------------|----------|

    | Development | `https://dev.go.simplytokenized.com/_api` |

    | Staging | `https://stage.go.floris3.com/_api` |

    | Live | `https://go.floris3.com/_api` |


    Authenticate with client credentials at `POST /_api/auth`, then call
    resource endpoints with `Authorization: Bearer {access_token}`.


    All successful responses include the `ST-Api-Version` header. The access
    token is valid for 10 minutes.


    **Token amounts:** Fields named `units` and `balance` are integer strings in
    the smallest token unit. Read `decimals` from the offering and multiply the
    human amount by `10^decimals` (e.g. 10 tokens with 8 decimals →
    `"10000000000"`). See the Units and decimals guide in the docs.
  version: '2026-07-02'
servers:
  - url: https://dev.go.simplytokenized.com
    description: Development — beta API version `2026-07-02` available
  - url: https://stage.go.floris3.com
    description: Staging
  - url: https://go.floris3.com
    description: Live (production)
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Obtain a bearer access token.
  - name: Offerings
    description: List and retrieve offerings.
  - name: Orders
    description: >-
      Create, list, retrieve, and cancel orders. Send `units` in the smallest
      token unit — see Units and decimals in the Guides tab.
  - name: Accounts
    description: Create and manage investor accounts.
  - name: Wallets
    description: List wallets and wallet balances.
  - name: Transactions
    description: Account transaction history.
  - name: Benefiting Persons
    description: Beneficial ownership records.
paths:
  /_api/offerings/{offeringId}:
    get:
      tags:
        - Offerings
      summary: Get offering
      operationId: getOffering
      parameters:
        - name: offeringId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: offeringId identifier
        - name: lang
          in: query
          required: true
          schema:
            default: en
            type: string
            enum:
              - ar
              - de
              - en
              - es
              - fr
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    nullable: true
                    type: string
                    format: uuid
                  name:
                    nullable: true
                    type: string
                  symbol:
                    nullable: true
                    type: string
                  isin:
                    nullable: true
                    type: string
                  wkn:
                    nullable: true
                    type: string
                  blockchain:
                    nullable: true
                    type: string
                  tokenization_platform:
                    nullable: true
                    type: string
                  decimals:
                    nullable: true
                    type: number
                  type:
                    nullable: true
                    type: string
                  status:
                    nullable: true
                    type: string
                  blockchain_status:
                    nullable: true
                    type: string
                  visibility_status:
                    nullable: true
                    type: string
                  featured:
                    type: boolean
                  logo:
                    nullable: true
                    type: string
                  issuer:
                    type: object
                    properties:
                      company_name:
                        nullable: true
                        type: string
                      street:
                        nullable: true
                        type: string
                      city:
                        nullable: true
                        type: string
                      zip:
                        nullable: true
                        type: string
                      state:
                        nullable: true
                        type: string
                      country:
                        nullable: true
                        type: string
                    required:
                      - company_name
                      - street
                      - city
                      - zip
                      - state
                      - country
                    additionalProperties: false
                  publication_valid:
                    nullable: true
                    type: boolean
                  publication_date:
                    nullable: true
                    type: string
                  contract_address:
                    nullable: true
                    type: string
                  price_per_token:
                    nullable: true
                    anyOf:
                      - type: string
                      - type: number
                  main_currency:
                    nullable: true
                    type: string
                  softcap:
                    nullable: true
                    anyOf:
                      - type: string
                      - type: number
                  hardcap:
                    nullable: true
                    anyOf:
                      - type: string
                      - type: number
                  investment_start_date:
                    nullable: true
                    type: string
                  investment_end_date:
                    nullable: true
                    type: string
                  max_token_per_account:
                    nullable: true
                    type: number
                  min_investment:
                    nullable: true
                    type: number
                  campaign:
                    type: object
                    properties:
                      short_description:
                        nullable: true
                        type: string
                      description:
                        nullable: true
                        type: string
                      faq:
                        nullable: true
                      list_view_image:
                        nullable: true
                        type: string
                      hero_image:
                        nullable: true
                        type: string
                      image_gallery:
                        type: array
                        items:
                          type: string
                      youtube_video_url:
                        nullable: true
                        type: string
                    required:
                      - short_description
                      - description
                      - faq
                      - list_view_image
                      - hero_image
                      - image_gallery
                      - youtube_video_url
                    additionalProperties: false
                  investment_documents:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        url:
                          type: string
                        document_type:
                          nullable: true
                          type: string
                        created_at:
                          nullable: true
                          type: string
                        name:
                          nullable: true
                          type: string
                        include_in_email:
                          type: boolean
                        index:
                          nullable: true
                          type: number
                        is_sign_required:
                          type: boolean
                      required:
                        - id
                        - url
                        - document_type
                        - created_at
                        - name
                        - include_in_email
                        - index
                        - is_sign_required
                      additionalProperties: false
                required:
                  - id
                  - name
                  - symbol
                  - isin
                  - wkn
                  - blockchain
                  - tokenization_platform
                  - decimals
                  - type
                  - status
                  - blockchain_status
                  - visibility_status
                  - featured
                  - logo
                  - issuer
                  - publication_valid
                  - publication_date
                  - contract_address
                  - price_per_token
                  - main_currency
                  - softcap
                  - hardcap
                  - investment_start_date
                  - investment_end_date
                  - max_token_per_account
                  - min_investment
                  - campaign
                  - investment_documents
                additionalProperties: false
              example:
                id: bf446783-f4b0-491a-b054-94d9dae23ec6
                name: Testing payout
                symbol: PAYO
                isin: '0'
                wkn: null
                blockchain: sepolia_testnet
                tokenization_platform: native
                decimals: 8
                type: EQUITY_TOKENIZED
                status: LIVE
                blockchain_status: ACTIVE
                visibility_status: PUBLIC
                featured: false
                logo: null
                issuer:
                  company_name: ''
                  street: ''
                  city: ''
                  zip: ''
                  state: ''
                  country: ''
                publication_valid: null
                publication_date: null
                contract_address: '0xc6d5a089940b1f9bcfdf8e22ebc6956e6139a444'
                price_per_token: '10'
                main_currency: USD
                softcap: ''
                hardcap: ''
                investment_start_date: null
                investment_end_date: null
                max_token_per_account: null
                min_investment: null
                campaign:
                  short_description: null
                  description: null
                  faq: null
                  list_view_image: null
                  hero_image: null
                  image_gallery: []
                  youtube_video_url: null
                investment_documents: []
        '400':
          description: Bad Request – validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      errors:
                        type: array
                        items: {}
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized – invalid or missing access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      errors:
                        type: array
                        items: {}
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden – insufficient scope
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      errors:
                        type: array
                        items: {}
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too Many Requests – rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      errors:
                        type: array
                        items: {}
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      errors:
                        type: array
                        items: {}
                    required:
                      - type
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer access token from POST /_api/auth

````