registration queryCopy link

Retrieves a property’s registration information at the unit level. This is useful in confirming a unit’s (or room type's) information and determining its jurisdiction’s requirements. The API returns the registration information in our system for all active and inactive units on the property.

In this example, compliant shows whether the unit is compliant and why; include this object and its fields to understand the regulatory status of the unit. Note that the complete field is not included because it reports information at a property level and does not provide the true value for some properties.

You can then use the updateUnitRegistration mutation to update registration information for active units only.

Syntax

1query { 
2  property(id: String!, idSource: IdSource) { 
3    units { 
4      registration: Registration 
5    } 
6  }
7} 

Example

The GraphQL explorer is provided for the example below. For more examples, refer to the Introduction.

Use this interactive explorer to get comfortable with the sample query.

• A test property ID is passed into the explorer for use by the query; its test data is returned.
• Click Run Query to execute the query in the explorer on the page. You can modify the query to retrieve the desired fields, and the explorer provides a list of fields when you start typing.
• Click API Explorer to launch the full explorer in another tab/window, which provides syntax highlighting, schema introspection, real-time error highlighting, and auto-completion, among other things.