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

# Get a subscription

> Retrieve a single webhook subscription by ID.



## OpenAPI

````yaml apis/fx-webhook/openapi.yml GET /v1/subscriptions/{subscriptionId}
openapi: 3.1.1
info:
  title: Trace Finance Webhooks API
  version: 1.0.0
  description: >
    API for managing webhook subscriptions and inspecting webhook delivery
    history on the Trace Finance platform.
servers:
  - url: https://api.sandbox.tracefinance.com
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Subscriptions
    description: Create, list, update, and delete webhook subscriptions.
  - name: Execution logs
    description: Inspect webhook delivery attempts and resend failed deliveries.
  - name: References
    description: Look up the resources and event types available for subscription.
paths:
  /v1/subscriptions/{subscriptionId}:
    get:
      tags:
        - Subscriptions
      summary: Get a subscription
      operationId: getSubscription
      parameters:
        - $ref: '#/components/parameters/SubscriptionId'
        - $ref: '#/components/parameters/TraceVersion'
      responses:
        '200':
          description: Subscription details.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          description: Subscription not found.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    SubscriptionId:
      name: subscriptionId
      in: path
      required: true
      description: UUID of the subscription.
      schema:
        type: string
        format: uuid
    TraceVersion:
      name: X-Trace-Version
      in: header
      required: false
      description: API version. Omit to use the default version.
      schema:
        type: string
        example: '1'
  headers:
    RequestId:
      description: >-
        Unique request identifier emitted on every response. Reference it when
        contacting Trace Finance support so we can trace the request end-to-end.
        See [Errors](/guides/principles/errors).
      schema:
        type: string
        format: uuid
  schemas:
    Subscription:
      type: object
      description: >-
        A webhook subscription that delivers events from one or more resources
        to a customer-controlled URL.
      properties:
        id:
          type: string
          format: uuid
          example: 8a13c6a4-1a3d-4f49-ad62-9dca8c47e2c6
          readOnly: true
        companyId:
          type: string
          description: Company identifier that owns the subscription.
          example: 11111111-1111-1111-1111-111111111111
        url:
          type: string
          format: uri
          example: https://api.example.com/trace-webhooks
        resources:
          type: array
          description: Resources and event types this subscription delivers.
          items:
            $ref: '#/components/schemas/SubscriptionResource'
        allowRetry:
          type: boolean
          description: Whether failed deliveries are retried.
          example: true
        createdAt:
          type: string
          format: date-time
          example: '2026-04-28T14:32:11Z'
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          example: '2026-04-28T14:32:11Z'
          readOnly: true
      required:
        - id
        - companyId
        - url
        - resources
        - allowRetry
        - createdAt
        - updatedAt
    ErrorResponse:
      type: object
      description: >-
        Standard error response. See the [Errors](/guides/principles/errors)
        guide for the full code catalog.
      properties:
        code:
          type: string
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          example: >-
            Subscription with id '8a13c6a4-1a3d-4f49-ad62-9dca8c47e2c6' was not
            found.
        details:
          type: object
          additionalProperties: true
      required:
        - code
        - message
    SubscriptionResource:
      type: object
      description: >-
        A resource the subscription delivers events for, with the chosen event
        types resolved.
      properties:
        name:
          $ref: '#/components/schemas/ResourceName'
        events:
          type: array
          items:
            $ref: '#/components/schemas/EventType'
      required:
        - name
        - events
    ResourceName:
      type: string
      description: The resource group an event belongs to.
      enum:
        - ACCOUNT
        - BENEFICIARY
        - OPERATION
      example: OPERATION
    EventType:
      type: string
      description: >-
        The specific event type within a resource, sent as the `X-Event-Type`
        header on each delivery.
      enum:
        - ACCOUNT_CREATED
        - ACCOUNT_ACTION_REQUIRED
        - ACCOUNT_ASSET_ACTIVATED
        - ACCOUNT_ASSET_FAILED
        - BENEFICIARY_PAYMENT_INSTRUCTION_CREATED
        - BENEFICIARY_PAYMENT_INSTRUCTION_APPROVED
        - BENEFICIARY_PAYMENT_INSTRUCTION_REJECTED
        - OPERATION_REQUESTED
        - OPERATION_COMPLETED
        - OPERATION_FAILED
        - OPERATION_CUSTOMER_ACTION_REQUIRED
      example: OPERATION_REQUESTED
  responses:
    UnauthorizedError:
      description: Missing or invalid authentication token.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT bearer token. Include as `Authorization: Bearer <token>`. See the
        [Authentication](/guides/authentication) guide for how to obtain one.

````