Skip to content

Core API Tenants

Get tenant details

gethttps://core-api.ancon.io/api/v1/Tenants

View .md OpenAPI

Authorization

Access-Tokenheaderrequired
Tenant- or outlet-level token from the backoffice. See Get started.

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

tenantobject | null
3 fields in tenant
- idstring (uuid)
- namestring | null
- shareableTypesinteger (int32)
  Allowed values: 0, 1, 2, 4, 8.

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X GET "https://core-api.ancon.io/api/v1/Tenants" \
  -H "Access-Token: $ANCON_TOKEN"

Response

Generated from the schema; values are placeholders.

{
  "tenant": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "shareableTypes": 0
  }
}