Harri Subscriptions API

The Subscriptions API from Harri — 1 operation(s) for subscriptions.

OpenAPI Specification

harri-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Harri Employee Open Subscriptions API
  description: 'API for managing and retrieving employee data in the Harri system. - Notice: Harri''s API enforces a rate limit of 400 requests per minute. Once you exceed this limit, an HTTP 403 error is returned with a body that informs you that the limit has been exceeded. Please examine the API returns for this error so your software can respond appropriately. After 4 June, 2026, the rate limiting error will change from 403 to 429.'
  termsOfService: https://harri.com/terms
  version: 1.0.0
servers:
- url: https://gateway.harri.com/open-api-hub
tags:
- name: Subscriptions
paths:
  /api/v1/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: List client subscriptions
      description: Retrieve all subscriptions for the authenticated client.
      operationId: ListClientSubscriptions
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    event_code:
                      type: string
                    webhook_url:
                      type: string
                    subscription_auth_type:
                      type: string
                    auth_config:
                      type: object
        '403':
          description: Unauthorized access
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth.harri.com/oauth2/token
          scopes: {}