Tenants

get

List all tenants.

Responses

200

Default Response

application/json

_idstringOptional

namestringOptional

photo_url_templatestringOptional

site_countnumberOptional

created_atstringOptional

updated_atstringOptional

get

/tenants

HTTPcURLJavaScriptPython

GET /tenants HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "name": "text",
    "photo_url_template": "text",
    "site_count": 1,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a tenant.

Body

application/json

namestringRequired

photo_url_templatestringOptional

Responses

200

Default Response

No content

post

/tenants

HTTPcURLJavaScriptPython

POST /tenants HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "name": "text",
  "photo_url_template": "text"
}

200

Default Response

No content

get

Retrieve a single tenant.

Path parameters

tenantIdstringRequired

Responses

200

Default Response

No content

get

/tenants/{tenantId}

HTTPcURLJavaScriptPython

GET /tenants/{tenantId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

patch

Update a tenant.

Path parameters

tenantIdstringRequired

Body

application/json

namestringOptional

photo_url_templatestringOptional

Responses

200

Default Response

No content

patch

/tenants/{tenantId}

HTTPcURLJavaScriptPython

PATCH /tenants/{tenantId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "name": "text",
  "photo_url_template": "text"
}

200

Default Response

No content

post

Assign a site to a tenant.

Path parameters

tenantIdstringRequired

siteIdstringRequired

Responses

200

Default Response

No content

post

/tenants/{tenantId}/sites/{siteId}

HTTPcURLJavaScriptPython

POST /tenants/{tenantId}/sites/{siteId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content