API Endpoints (Overview)

This page gives a customer-facing overview of the InvyMate API: how authentication works, what resource groups are available, and how requests are structured.

Authentication

API access uses API keys generated in Configuration → API Keys.
Tokens are shown once, so store them securely.
Use the header format:
- Authorization: ApiKey <token>

Base URL

Use your workspace URL with the versioned API path:

https://<workspace>.invymate.com/api/v1/...

Main resource groups

Common API areas include:

assets
people
inventory sessions
recurring session schedules
categories and locations
custom fields and layouts
API keys
webhooks
reporting and exports where available

The exact resources you use depend on the workflows your workspace has enabled.

Common request pattern

Most integrations follow the same shape:

list records with GET
create records with POST
update records with PATCH
fetch a single record by ID when you need detail or follow-up actions

Example requests

List assets:

curl "https://<workspace>.invymate.com/api/v1/inventory-items" \
  -H "Authorization: ApiKey <token>"

List people:

curl "https://<workspace>.invymate.com/api/v1/people" \
  -H "Authorization: ApiKey <token>"

People are active by default. Use ?status=all to include deactivated, non-deleted people in list results. Person responses include status; update a person with PATCH /people/:id and { "status": "active" | "deactivated" } to reactivate or deactivate them. Deactivation requires all current asset assignments to be unassigned first.

List inventory sessions:

curl "https://<workspace>.invymate.com/api/v1/sessions" \
  -H "Authorization: ApiKey <token>"

Errors and follow-up

If a request fails:

confirm you are using the correct workspace URL
confirm the API key is active
verify the Authorization: ApiKey <token> header format
check whether the workflow you need is available in your current plan

Use API Access for setup and Webhooks for event-driven integrations.