Create an API key
Connect another system to MetriCRM through the REST API with a scoped, revocable key.
For: Workspace admins and developersSteps
- Open Settings → API keys and select Create API key.
- Name the key after the system that will use it (for example “ERP sync”), so you can recognise it later.
- Tick Read or Write for each kind of record the system needs — nothing more. Write includes read.
- Choose when the key expires, how many requests per minute it may make and, if the system has fixed addresses, the IP addresses or ranges it may call from.
- Select Create key and copy the key straight away — MetriCRM shows it only once. Store it in the other system's secret settings, never in code or email.
- Check the key with GET https://api.metricrm.com/v1/me and follow the API reference (/docs/api) for each endpoint.
Good to know
- A key acts as you and can never do more than your role allows. If you are deactivated, your keys stop working.
- Revoke a key you no longer use, or one that may have leaked — it stops working at once. Create a new one for the system.
- Send an Idempotency-Key header with POST requests so a retried request never creates a duplicate.
Still need help? Contact support