Jump to Content

Home Guides API Reference Discussions

API Reference

Home Guides API Reference Discussions

Flex Identity 2.0

Me
Tenants
Members
Users
Invitations
Registration
- Accept invitationpost
- Gets an invitation but only if it is acceptable by the current user. This is mainly to be used by other APIs to check if the invitation can be propagated into their access controll levels.get
ClientApplications
Masters
PaymentWebhook
- Post webhookpost
Subscriptions
Portal
- Post portalpost
Payment
- Post checkoutpost
- Get plan by tenantIdget
Authentication
- Get tokenpost

Flex AIM 2.0

Assets
Models
ModelFiles
- Downloads the model as originally uploadedget
- A one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processingpost
Contacts
Sites
Facilities
Levels
Spaces
Zones
ComponentTypes
Components
Systems
Assemblies
Spares
Resources
Jobs
Issues
Documents
DocumentFiles
- Downloads binary file related to asset and modelget
- Uploads a document file related to a specific modelpost
Entities
Applications
- Returns the entity with the key from Applicationsget
- Returns the EntitySet Applicationsget
Attributes
AttributeValues
- Returns the EntitySet AttributeValuesget
Schedules
Wexbim
Floorplans
- Get Floor planpost
- Get Room planpost
Thumbnails
- Get Thumbnails asset thumbnailget
- Post Thumbnails asset thumbnailpost
ModelMapping
Stats
- Lists the plan allowances and current consumpttion for a tenant's appget
Diagnostics
- Returns the EntitySet Diagnosticsget
Logs
- Imports a batch of logs to the central logging servicepost
Admin
Invitation
- Updates the users permissions after an invite has been acceptedput

Flex Comms 2.0

Contacts
- Get Contactsget
- Get Contacts searchget
Conversations
Files
- Gets a File Blob from a Messageget
Snapshots
- Gets a File Blob from a Messageget
ValidationResults
- Gets a the validation results in a conversation by its file Idget

Flex Workflows

Artifacts
- Get Artifacts listget
- Get Artifacts download artifactget
CleanPastInstances
- Post CleanPastInstancespost
FlowTemplates
Health
- Get Health statusget
Instances
Operations
- Post Operations get allowedpost
Pipelines
Resources
- Get Resources list instanceget
- Get Resources download instance resourceget
ServiceConnections
Stats
Triggers
ValidationResults

Flex IoT

MappingEntities
Presentations
Remapping
- (Auth policies: Admin)put
Sensors
SensorTags
Tags
Units
- Get all the unit definitions available to the current user in the current resource scope (Auth policies: IotRead)get
- Get conversion factor betwee two inits. These two units must have a common ancestor in the units definition hierarchy (conversion based units poin to Xbim.Flex.IOT.Services.Contracts.UnitDto.ConversionBaseUnit) (Auth policies: IotRead)get

Powered by

Get Contacts

get https://apis.xbim-dev.net/{region}/comms/2.0/Contacts

Summary:Return Type: ContactList

Language

Credentials

OAuth2

Bearer

Log in to use your API keys

Click Try It! to start a request and see the response here!