generated: '2026-07-31'
method: derived
source: openapi/accessibe-partners-openapi-original.yml
docs: https://dashboard.accessibe.com/api/v1/partners/docs
api: accessiBe Partners API License 1.0.1
base_url: https://dashboard.accessibe.com/api/v1/partners
authentication:
  style: api-key
  header: x-api-key
  scope: per-account; the key must match the accountId in the request path
  prerequisite: the account must be enabled as a partner account
  key_location: Customer Portal - Account Settings - Subscriptions API/CSV access
  artifact: authentication/accessibe-authentication.yml
idempotency:
  supported: true
  header: Idempotency-Key
  type: string
  required: false
  scope: batch operations only
  operations:
  - POST /accounts/{accountId}/access-widget-licenses/batch-create
  - POST /accounts/{accountId}/access-widget-licenses/batch-update
  description: A unique key to ensure the request is processed only once.
  retention: not documented
  note: The single-license POST and PATCH operations do not declare an Idempotency-Key
    parameter; only the two batch endpoints do.
  evidence: openapi/accessibe-partners-openapi-original.yml -> parameters[name=Idempotency-Key]
pagination:
  style: cursor
  request_params:
  - name: nextToken
    in: query
    description: Token used in pagination to retrieve the next set of results. Make
      the call again using the returned token to retrieve the next results.
  - name: limit
    in: query
    type: integer
    default: 10
    example: 3
    description: The number of results to return.
  response_field: nextToken
  operations:
  - GET /accounts/{accountId}/access-widget-licenses
filtering:
  operations:
  - GET /accounts/{accountId}/access-widget-licenses
  params:
  - name: status
    enum: [active, trial, expired, grace]
  - name: domain
    description: Filter the results by domain. This is the documented way to resolve
      a licenseId for a given domain.
field_expansion:
  supported: true
  param: expand[]
  component: '#/components/parameters/ExpandSettingsParam'
  values: [settings]
  operations:
  - GET /accounts/{accountId}/access-widget-licenses/{licenseId}
  - GET /accounts/{accountId}/access-widget-licenses
  description: Expands extra fields in the response. If present, includes maxImagesReached,
    maxImagesLimit, and the settings object (which relates to customization settings).
async_batch:
  supported: true
  max_items_per_request: 150
  accepted_status: 202
  handle_field: batchId
  poll_operation: GET /accounts/{accountId}/access-widget-licenses/batch/{batchId}
  poll_semantics: 200 when the batch has completed, 202 while it is still processing
  note: The help-centre CSV path documents a 250-row limit per upload; the API batch
    limit declared in the OpenAPI is 150 licenses per request.
request_tracing:
  request_id_header: not documented
versioning:
  scheme: uri-path
  current: v1
  spec_version: 1.0.1
  path_prefix: /api/v1/partners
  artifact: lifecycle/accessibe-lifecycle.yml
error_envelope:
  format: custom-envelope
  problem_json: false
  fields: [success, message, data]
  artifact: errors/accessibe-problem-types.yml
rate_limiting:
  documented: false
  headers: not documented
  note: No 429 response and no rate-limit headers are declared in the specification
    or in the published documentation.
content_type: application/json
cross_links:
  authentication: authentication/accessibe-authentication.yml
  errors: errors/accessibe-problem-types.yml
  lifecycle: lifecycle/accessibe-lifecycle.yml
  data_model: data-model/accessibe-data-model.yml