API ReferenceTenants
List tenants
List your tenants, newest first. Filter by externalId to find the tenant you created for one of your own users. Partner accounts only: call it with your partner account's account-wide key, which needs the admin scope, and without X-Tenant-Id.
AuthorizationBearer <token>
API key in the Authorization header: Authorization: Bearer ace_live_.... Use an ace_test_... key for the free, rate-capped sandbox.
In: header
Query Parameters
externalId?string
Length
length <= 255status?string
Value in
- "active"
- "suspended"
page?integer
Range
1 <= valueDefault
1pageSize?integer
Range
1 <= value <= 100Default
20Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/tenants"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "name": "string", "status": "active", "config": { "brandVoice": { "tone": "string", "contentStyle": "string", "targetAudience": "string", "languageComplexity": "string", "language": "string" }, "targetLanguage": "en-GB", "creativityLevel": 1, "contentTypes": [ "product-description", "meta-tags" ], "reviewQueue": false }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "pagination": { "page": 1, "pageSize": 50, "total": 128, "totalPages": 3 } }}