API Access

API Access lets you integrate InvyMate data with your tools such as dashboards, reporting jobs, and internal scripts.

For a copyable read-only integration example, see the Example TypeScript client.

If you need outbound push instead of polling, use Webhooks.

What it is

With API Access, you generate API keys and use them to call protected endpoints for your workspace.

API keys are separate from the read-only MCP integration. MCP uses per-user access and a bearer token to expose five fixed, read-only asset, person, assignment, custody-history, and inventory-session tools to Claude Code or Codex; it does not create API keys or provide general API access. See MCP Access for details.

How to get started

• Navigate to Configuration → API Keys
• Create an API key
  • Choose a descriptive name such as IT audit export script
• Copy the token
  • The token is shown only once
  • Store it in a secret manager
• Rotate or revoke keys as needed
• Use the correct auth header format in requests:
  • Authorization: ApiKey <token>

API configuration

Use workspace-scoped API URLs.

• Production pattern: https://<workspace>.invymate.com/api/v1/...

Make sure you call the API for the correct workspace URL and keep your API keys out of client-side code.

For endpoint groups and common request patterns, see:

• API Endpoints (Overview)
• Webhooks