Send your first API request

Start with GET /v1/account. It is a read-only request that confirms the API key works and shows which MailGraf account it belongs to. It does not expose billing details, users or other account settings.

Before you start

Create an API key under Settings > API keys and copy it when it is shown. If you have not prepared the Authorization header yet, read Authentication.

Check the connection

1. Open a terminal

   Use a terminal on a trusted computer. Do not run a request containing a live key in a shared browser console or public code playground.

2. Send the account request

   Replace mg_live_... with your key and run the command below.

curl https://api.mailgraf.com/v1/account \
  -H "Authorization: Bearer mg_live_..."

1. Read the response

   A successful request returns HTTP 200 with the account id and name.

{
  "id": 42,
  "name": "Northstar Studio"
}

The values come from the account connected to your key, so your response will be different.

Resolve a failed request

• 401 Unauthorized: check that the header starts with Bearer and that the key has not been revoked.
• 403 Forbidden: the account's current plan does not include API access.
• 429 Too Many Requests: wait for the number of seconds in the Retry-After response header before trying again.

Do not keep retrying a 401 or 403 response. Correct the key or account access first.

Where the full reference lives

See GET /v1/account in the API reference for the current response schema and all documented errors.