List partner tenants
Retrieves all tenants registered to the partner.
path Parameters
partnerIdThe partner identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List partner tenants › Responses
OK
Register a tenant
Registers a new tenant for the partner. This creates the tenant in the payroll system and grants the partner access to manage it.
path Parameters
partnerIdThe partner identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Register a tenant › Responses
Created
Get tenant details
Retrieves details for a specific tenant registered to the partner.
path Parameters
partnerIdThe partner identifier
tenantIdThe tenant identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get tenant details › Responses
OK
Update tenant registration
Updates registration details for a tenant (e.g., external ID).
path Parameters
partnerIdThe partner identifier
tenantIdThe tenant identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Update tenant registration › Responses
OK
Unregister a tenant
Removes the tenant from the partner's portfolio. The tenant data remains in the system but the partner loses access.
path Parameters
partnerIdThe partner identifier
tenantIdThe tenant identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Unregister a tenant › Responses
No Content