Skip to main content

Managing Contracts

This documentation will help you use the public Contracts API: creation, retrieval, and update.

Concept

A contract can be linked to:

  • One or more assets
  • One or more equipments (identified by holdertype codes)
  • One or more stakeholders

Contracts can represent various use cases, such as rental leases or equipment maintenance contracts within assets.

ParameterFormat
assets["uid1", "uid2", ...]
stakeholders["uid1", "uid2", ...]
equipments["holdertype_code1", "holdertype_code2", ...]

Authentication

All requests require a Bearer token and an organization code:

organization=your_organization
token=your_token