General REST principles

The following are general principles that we follow across our APIs.

All API endpoint URLs specify the service name and version in the URL in the form:

https://gotlivedata.io/api/<service name>/<version>/...

There may be multiple version numbers available at any time.

The following are the current API services and latest version:

• Identity Service (v1) - provides functions for managing your Live Data organization and user access to your resources
• Ledger Service (v1) - manage the contacts that Live Data tracks across one or more ledgers in your organization

All APIs are documented using OpenAPI 3.0 and all documentation is available here. We provide interactive API documentation that allows you to make calls directly in your browser. Our documentation is validated against our backend continuously.

Resource, path, and attribute names are formatted in camelCase.

All resources in the API have documented schemas that have similar characteristics:

• all contain attributes that lack their resource name. For example, a ledger resource will have the attributes id and name, not ledgerId and ledgerName

All date attributes across the APIs, where they exist, are named as follows: createdAt, updatedAt, deletedAt. Other date attributes are similarly named.