For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
GuidesModelsAPI reference
GuidesModelsAPI reference
  • API Overview
  • Management API
      • GETList API keys
      • POSTCreate an API key
      • GETGet an API key
      • DELDelete an API key
      • PATCHUpdate an API key

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Management APIAPI keys

Get an API key

GET
https://gateway.merge.dev/v1/keys/:key_hash
GET
/v1/keys/:key_hash
$curl https://gateway.merge.dev/v1/keys/key_hash \
> -H "Authorization: Bearer <token>"
1{
2 "hash": "a1b2c3d4e5f6",
3 "label": "mg_8Kx2pQ",
4 "disabled": false,
5 "usage": 12.4,
6 "name": "customer-acme",
7 "limit": 50,
8 "limit_reset": "monthly",
9 "limit_remaining": 37.6,
10 "created_at": "2026-06-02T17:04:00Z"
11}
Return a single key with its current usage.
Was this page helpful?
Previous

Create an API key

Next

Delete an API key

Authentication

AuthorizationBearer

A management key (prefixed mgmt_), created in the dashboard under Settings, API keys, Management keys. Distinct from a regular gateway API key, and never used to call models.

Path parameters

key_hashstringRequired

The key’s hash from a create or list response.

Response

The key.
hashstring

Stable identifier for the key. A one-way hash, not the secret, so it is safe to store and log. Use it in get, update, and delete calls.

labelstring

Display label (the key’s public prefix, e.g. mg_8Kx2pQ). Not the secret.

disabledboolean
Whether the key is disabled. A disabled key cannot call the gateway but is not deleted.
usagedouble
Spend in USD in the current reset window.
namestring or null

User-set name for the key.

limitdouble or null
Spend cap in USD over the reset window. Null means no cap.
limit_resetenum
Window the spend cap resets on. Resets at midnight UTC.
Allowed values:
limit_remainingdouble or null
Remaining spend in USD before the cap. Null when no limit is set.
created_atdatetime or null
When the key was created.

Errors

401
Unauthorized Error
404
Not Found Error