Tenants
List tenants
List tenants for the current environment.
get/v1/tenants
Query parameters
tenant_idstring
Filter tenants by ID.
namestring
Filter tenants by name.
afterstring
The cursor to fetch entries after.
beforestring
The cursor to fetch entries before.
page_sizeinteger
The number of items per page (defaults to 50).
Response
OK
Example response
{
"entries": [
{
"__typename": "Tenant",
"id": "tenant_jp123",
"name": "Jurassic Park",
"settings": {
"branding": {
"icon_url": "https://example.com/trex_silhouette_icon.png",
"logo_url": "https://example.com/amber_fossil_logo.png",
"primary_color": "#DF1A22",
"primary_color_contrast": "#FFDE00"
},
"preference_set": {
"categories": {
"safety": {
"channel_types": {
"email": true,
"push": true
}
}
},
"channel_types": {
"email": true,
"in_app_feed": true,
"push": true
},
"id": "default",
"workflows": {
"park_alert": {
"channel_types": {
"email": true,
"push": true
}
}
}
}
}
}
],
"page_info": {
"__typename": "PageInfo",
"after": null,
"before": null,
"page_size": 25
}
}