API reference

Verify credentials

GET/ping

Returns the environment, organization and key that authenticated the request. Use it to confirm that a key is valid and points at the expected environment.

Required scope: none
Idempotency-Key: Not used
Environments: Sandbox and Live

Example request

curl "https://api.gloresend.com/sandbox/v1/ping" \
  -H "Authorization: Bearer $GLORESEND_TEST_KEY"

Response · 200

200 · application/json

{
  "object": "ping",
  "environment": "sandbox",
  "organization": {
    "id": "org_7h3k2l9m4n5b6v8c",
    "name": "Acme Payouts"
  },
  "api_key": {
    "id": "key_2p9o8i7u6y5t4r3e",
    "prefix": "gs_test_a1B2c3",
    "scopes": [
      "balances:read",
      "transfers:read",
      "transfers:write"
    ]
  },
  "server_time": "2026-10-15T09:30:00.000Z"
}

Response fields

objectenumrequired
"ping"
environmentenumrequired
"sandbox", "live"
organizationobjectrequired
organization.idstringrequired
organization.namestringrequired
api_keyobjectrequired
api_key.idstringrequired
api_key.prefixstringrequired
api_key.scopesarray of enumrequired
server_timestringrequired
date-time

Errors

401authentication_requiredNo credentials were supplied. Send Authorization: Bearer <api key>.
401invalid_api_keyThe API key is unknown, revoked or expired.
401environment_mismatchThe API key belongs to a different environment than the base URL you called. Sandbox keys (gs_test_) only work against the Sandbox base URL, Live keys (gs_live_) only against the Live base URL.
429rate_limitedToo many requests. Wait for the number of seconds in the Retry-After header.