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

# Get listing

> Returns a single listing by id.



## OpenAPI

````yaml /openapi.yaml get /v1/listings/{id}
openapi: 3.1.0
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
security:
  - organizationApiKey: []
  - oauthAccessToken: []
tags:
  - name: Auth
  - name: Management
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
  - name: Messaging
paths:
  /v1/listings/{id}:
    get:
      tags:
        - Catalog
      summary: Get listing
      description: Returns a single listing by id.
      operationId: listings_get_by_id
      parameters:
        - schema:
            type: string
            description: Identifier of the listing.
          required: true
          description: Identifier of the listing.
          name: id
          in: path
      responses:
        '200':
          description: Listing details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetListingResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '404':
          description: Listing not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    GetListingResponse:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
          description: Unique identifier of the listing.
          example: lis_1234567890abcdefghij
        createdAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the listing was created.
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the listing was last updated.
          example: '2025-01-01T00:00:00.000Z'
        organizationId:
          type: string
          description: Identifier of the owning organization.
          example: org_1234567890abcdefghij
        name:
          type:
            - string
            - 'null'
          description: Optional display name of the listing.
          example: Inscripción 2025
        description:
          type:
            - string
            - 'null'
          description: Optional description of the listing.
          example: null
        url:
          type: string
          description: Public URL slug for the payment listing page.
          example: inscripcion-2025
        private:
          type: boolean
          description: Whether the listing is restricted to invited customers.
          example: false
        active:
          type: boolean
          description: Whether the listing is currently accepting payments.
          example: true
        recurrentDetailId:
          type:
            - string
            - 'null'
          description: >-
            Identifier of the recurrence configuration, if this is a
            subscription listing.
        templateId:
          type:
            - string
            - 'null'
          description: >-
            Identifier of the subscription template used by this listing, if
            any.
          example: null
        onlyAutomaticCollection:
          type: boolean
          description: Whether this listing requires automatic payment collection.
          example: false
        items:
          type: array
          items:
            $ref: '#/components/schemas/ListingItem'
          description: Products or services offered in this listing.
          example: []
        form:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              description: Unique identifier of the form.
              example: fo_1234567890abcdefghij
            fields:
              type: array
              items:
                $ref: '#/components/schemas/FormField'
              description: Ordered list of fields in the form.
              example: []
          required:
            - id
            - fields
          description: Optional data collection form shown to the payer.
          example: null
        recurrentDetail:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              description: Unique identifier of the recurrent detail.
              example: rdet_1234567890abcdefghij
            chargeEach:
              type: number
              description: Number of intervals between charges.
              example: 1
            collectionInterval:
              type: string
              enum:
                - DAY
                - WEEK
                - FORTNIGHT
                - MONTH
                - YEAR
              description: Time interval unit for recurring charges.
              example: MONTH
            toleranceDays:
              type:
                - number
                - 'null'
              description: Grace days after the due date before the invoice expires.
              example: 5
          required:
            - id
            - chargeEach
            - collectionInterval
          description: Recurrence configuration when this is a subscription listing.
          example: null
      required:
        - id
        - createdAt
        - updatedAt
        - organizationId
        - name
        - description
        - url
        - private
        - active
        - recurrentDetailId
        - templateId
        - onlyAutomaticCollection
        - items
      description: Listing details.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    ListingItem:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the listing item.
          example: lisi_1234567890abcdefghij
        quantity:
          type: integer
          exclusiveMinimum: 0
          description: Default quantity of units for this concept.
          example: 1
        concept:
          $ref: '#/components/schemas/PaymentConcept'
          description: The payment concept associated with this listing item.
      required:
        - id
        - quantity
        - concept
      description: >-
        A line item in a payment listing, linking a concept to a default
        quantity.
    FormField:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the form field.
          example: que_1234567890abcdefghij
        text:
          type: string
          description: Label or question text shown to the payer.
          example: Nombre del alumno
        name:
          type: string
          description: Internal field name key.
          example: student_name
        order:
          type: integer
          description: Display order of the field within the form.
          example: 1
      required:
        - id
        - text
        - name
        - order
      description: A single field in a payment form.
    PaymentConcept:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the payment concept.
          example: pc_1234567890abcdefghij
        createdAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the concept was created.
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the concept was last updated.
          example: '2025-01-01T00:00:00.000Z'
        displayName:
          type: string
          description: Name of the product or service shown to customers.
          example: Colegiatura
        description:
          type:
            - string
            - 'null'
          description: Optional longer description of the product or service.
          example: Colegiatura mensual de preparatoria
        amount:
          type: number
          description: Unit price in minor currency units (e.g. cents).
          example: 150000
        currency:
          type: string
          description: ISO 4217 currency code.
          example: MXN
        organizationId:
          type: string
          description: Identifier of the owning organization.
          example: org_1234567890abcdefghij
        active:
          type: boolean
          description: Whether this concept is currently available for use.
          example: true
        sku:
          type:
            - string
            - 'null'
          description: Optional SKU for internal identification.
          example: COL-PREP-001
        recurrentDetailId:
          type:
            - string
            - 'null'
          description: Identifier of the recurrence configuration, if applicable.
          example: null
        amountEditable:
          type: boolean
          description: Whether customers can customize the price.
          example: false
        quantityEditable:
          type: boolean
          description: Whether customers can customize the quantity.
          example: false
        archivedAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
            - type: 'null'
          description: Date and time when the concept was archived, if any.
          example: null
        oneOff:
          type: boolean
          description: Whether this concept is a one-time custom charge.
          example: false
        groupId:
          type:
            - string
            - 'null'
          description: Identifier of the group this concept belongs to, if any.
          example: null
        recurrentDetail:
          type:
            - object
            - 'null'
          properties:
            collectionInterval:
              type: string
              enum:
                - DAY
                - WEEK
                - FORTNIGHT
                - MONTH
                - YEAR
              description: Time interval unit for recurring charges.
              example: MONTH
            chargeEach:
              type: number
              description: Number of intervals between charges.
              example: 1
            toleranceDays:
              type:
                - number
                - 'null'
              description: Grace days after the due date before the invoice expires.
              example: 5
          required:
            - collectionInterval
            - chargeEach
          description: Recurrence configuration when the concept is a recurring charge.
          example: null
        metadata:
          type:
            - array
            - 'null'
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
              - key
              - value
          description: Structured metadata entries attached to the concept.
          example: []
        meta:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
          description: Flattened metadata map where each key maps to a string value.
          example: {}
      required:
        - id
        - createdAt
        - updatedAt
        - displayName
        - description
        - amount
        - currency
        - organizationId
        - active
        - sku
        - recurrentDetailId
        - amountEditable
        - quantityEditable
        - archivedAt
        - oneOff
        - groupId
      description: A product or service template used to define invoice line items.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'
    oauthAccessToken:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1
      description: 'OAuth access token using `Authorization: Bearer qoa_at_...`.'

````

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