Models
The objects the endpoints take and answer with, field by field.
ApiStatusErrorWhat a failed request answers with, together with its HTTP status. Branch on errorCode ; errorMessage is for people and may change.SuccessAccessTokenRequestAccessTokenEmbedTokenSignInTokenEnvironmentWhich world the key, and everything made with it, belongs to. See Live and sandbox .AccessLevelWho can open the project. private : only its members. view_only and public : anyone with the link or an embed can look at it. open_guest : a guest project of an Open Guest plan.ProjectProjectPageGuestThe guest's contact details, for an Open Guest project. Each is optional.ProjectCreatePersonProjectCreateItemUpdateFolderFolderCreatePointOne corner of a shape.PolygonAn area or a line drawn on the map.SpotA marked spot on the map.ImageOverlayA picture laid over the map, such as a site plan.CommentUserAn account.EnterpriseRoleA member's role in the organisation. user is shown as Member in the app.MemberCreateMemberUpdatePriceTierOne band of a range price. The whole quantity is charged at the rate of the band it falls in.AreaUnitAn area unit. Common spellings such as sqm , sqft and acre are accepted and stored as these.DistanceUnitA length unit. Common spellings such as meters , feet and miles are accepted and stored as these.PricingHow a product is charged, by area, by length or per spot. A new price needs its unit and currency ; on an update, a price sent without them keeps the product's own.SeasonA window of the year, recurring every year, with prices of its own. A window may wrap the year end.ProductProductInputA product's fields. name is needed to create one.ArchivedProduct