Endpoints references

Profile endpoints

Get Profile by Identifier

Retrieves a user’s profile using their email hash or profile URL slug (SHA256 hash of an email address or profile URL slug).

Endpoint: GET /profiles/{profileIdentifier}

Authentication:

  • Bearer Token (API Key)

URL Parameters:

  • profileIdentifier (required): SHA256 hash of email or profile URL slug

Response:

  • 200 OK: Successfully retrieved profile
  • 404 Not Found: Profile not found
  • 429 Too Many Requests: Rate limit exceeded

Example Request:

# With authentication

curl -X GET "https://api.gravatar.com/v3/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee" \

  -H "Authorization: Bearer YOUR_API_KEY"

Example Response:

{

  "hash": "84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee",

  "profile_url": "https://gravatar.com/example",

  "avatar_url": "https://0.gravatar.com/avatar/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee",

  "avatar_alt_text": "User's avatar",

  "display_name": "John Smith",

  "pronouns": "He/Him",

  "location": "San Francisco, CA",

  "job_title": "Software Engineer",

  "company": "Tech Company",

  "description": "About me section text",

  "verified_accounts": [

    {

      "service_type": "twitter",

      "service_label": "Twitter",

      "service_icon": "https://example.com/icon.png",

      "url": "https://twitter.com/username",

      "is_hidden": false

    }

  ]

}

QR code endpoints

Generates a QR code for a profile.

Endpoint: GET /qr-code/{sha256_hash}

Authentication:

  • Public (no authentication required)

URL Parameters:

  • sha256_hash (required): SHA256 hash of email or profile URL slug

Query Parameters:

  • size (optional): Size of QR code in pixels (default: 80)
  • version (optional): QR code style (1: standard, 3: modern dots)
  • utm_medium (optional): UTM medium parameter
  • utm_campaign (optional): UTM campaign parameter
  • type (optional): Center icon type (user, gravatar, none)

Response:

  • 200 OK: QR code image (PNG format)
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error

Example Request:

curl -X GET "https://api.gravatar.com/v3/qr-code/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee?size=300&type=user&version=3"


Last updated on: