OLIFY API

The OLIFY API is a REST API for the OLIFY application platform. Use it to extend the application's features, build integrations, and work with your tenant data over HTTP.

Directory operations on the same host issue access tokens and look up users and tenants.

Base URL

https://api.olify.io

Append the operation path directly to this origin:

https://api.olify.io/assets
https://api.olify.io/localities/{id}
https://api.olify.io/directory/connect/token

Requests and responses use JSON unless an operation specifies another media type. JSON property names are camelCase, enum values are strings, and timestamps are ISO-8601 instants.

Authentication

OLIFY issues a client ID and client secret for a Directory service account. Exchange those credentials for an access token at POST /directory/connect/token, then send the token with every subsequent request:

Authorization: Bearer {access_token}

Tenant-scoped operations also require the tenant GUID issued with your credentials:

Olify-Tenant-Id: {tenant_id}

See Authentication and Tenancy for the complete request flow.

Create requests require a client-generated UUID in the JSON id property. Successful POST, PUT, and DELETE operations typically return HTTP 200 with an empty body. Follow a write with GET /{id} when your application needs the stored representation.

The Operations section in the sidebar documents each HTTP operation, including its request and response schema.

Guides