Authentication

Every Gearment API request must be authenticated with an API key. Unauthenticated requests are rejected with 401.

Obtain your API key

1. Open Team Settings in the Gearment platform.
2. Go to Developer Settings.
3. Request and generate your API key.

You can go straight to Developer Settings > API credentials.

A credential pair belongs to a Gearment team. API access is evaluated against that team, and the rate limit is counted per team rather than per credential.

Keep your credentials private

Do not share your API key publicly or embed it in client-side applications. If a key is compromised, revoke it and generate a new one immediately.

Rejected requests

Condition	Response
Neither credential header is present	401 - {"status":"error","message":"no credentials provided"}
The key is unknown or expired, or the secret does not match the key	401 - {"status":"error","message":"error invalid credentials"}

Every error response also carries a request_id. Quote it when you contact support about a specific call.

Continue to Using API Key for the exact headers to send.