Host Building (1.0.0)
Download OpenAPI specification:Download
E-mail: hostbuilding@cbre.com
Most error responses are compliant with https://datatracker.ietf.org/doc/html/rfc7807
We currently support:
- Sending push notifications to users
- Retrieving bulk data for analyics and third-party integration
Getting your API key
These are issued on request to Host and will be scoped to the region, client, building/s and APIs required, you may be required to provide information on your use case
Send a push message to a user
Authorizations:
bearerAuth
Request Body schema: application/json
Push notification to send to the user with optional deeplink
| email required | string Email for user to push to |
| title required | string Title for push notification |
| content required | string Content for push notification |
object Optional deeplink, for Host App deeplinks talk with Host team |
Responses
Request samples
- Payload
Content type
application/json
{- "email": "user@email.com",
- "title": "Your parking expires soon",
- "content": "Your parking expires at 4:30pm. Please ensure you leave enough time to exit the carpark",
- "deeplink": {
- "type": "event",
- "id": 892,
- "category": 1
}
}Response samples
- 200
- 403
- 404
- 500
Content type
application/json
{- "title": "Push notification sent",
- "detail": "The push notification was sent to the user.",
- "status": 200
}Get reports for a client
Authorizations:
ApiKeyAuth
Request Body schema: application/json
| clientid | int Client id to request data for |
| type | string Report requested |
| date_from | string |
| date_to | string |
| format | string Enum: "json" "csv" Format to return results in |
| page | int |
Responses
Request samples
- Payload
Content type
application/json
{- "clientid": 1,
- "type": "events",
- "date_from": "2021-08-30",
- "date_to": "2021-09-30",
- "format": "json",
- "page": 1
}Response samples
- 200
Content type
{- "totalResults": null,
- "totalOnpage": null,
- "page": null,
- "totalPages": null,
- "results": [ ]
}