Payment ReconcilerDocumentation
QFind anything/
API Reference

Managing Tenants

Create, list, update, and delete tenants. Tenant lifecycle and attributes.

Tenant attributes

AttributeDescription
nameDisplay name (e.g. "Acme Corporation")
slugURL-friendly unique identifier. Auto-generated from name if omitted.
abbreviationShort code (3–5 chars). Used in references. Auto-generated if omitted.
statusACTIVE, SUSPENDED, INACTIVE. Only ACTIVE tenants accept API requests.

Slug and abbreviation must be unique across all tenants.

When to create a tenant

Create a tenant when you need a new isolated workspace—e.g. a new customer, brand, or business unit. After creation:

  1. Add environments via POST /tenants/:id/environments
  2. Configure settings via PATCH /tenants/:id/settings
  3. Assign users via the Users API

Operations

OperationMethodEndpoint
Create a tenantPOST/tenants
List tenantsGET/tenants
Retrieve a tenantGET/tenants/:id
Update a tenantPATCH/tenants/:id
Delete a tenantDELETE/tenants/:id

For full parameter definitions, request/response samples, and code examples, see the API Reference.

Update and delete

  • Update — Change name, slug, abbreviation, or status. Slug and abbreviation remain unique.
  • Delete — Permanently removes the tenant and all related data (environments, settings, expected/incoming transactions, matches, data sources, webhooks, jobs). Use with caution.