Data models

Note: You can play with our free public API data via our Developer Console.

Profile

A user’s profile information.

Properties:

  • hash: SHA256 hash of the user’s primary email address
  • display_name: The user’s display name
  • profile_url: Full URL for the user’s profile
  • avatar_url: URL for the user’s avatar image
  • avatar_alt_text: Alt text for the user’s avatar image
  • location: User’s location
  • description: About section on user’s profile
  • job_title: User’s job title
  • company: User’s current company name
  • verified_accounts: List of verified accounts
  • pronunciation: Phonetic pronunciation of user’s name
  • pronouns: User’s pronouns
  • timezone: User’s timezone
  • languages: Languages the user knows
  • first_name: User’s first name
  • last_name: User’s last name
  • is_organization: Whether user is an organization
  • header_image: Header image used in profile card
  • background_color: Profile background color
  • links: List of links added to profile
  • interests: List of interests added to profile
  • payments: User’s public payment information
  • contact_info: User’s contact information
  • gallery: Additional images uploaded by user
  • number_verified_accounts: Count of verified accounts
  • last_profile_edit: When user last edited profile
  • registration_date: When user registered account

Avatar

An avatar that a user has uploaded to their Gravatar account.

Properties:

  • image_id: Unique identifier for the image
  • image_url: Image URL
  • rating: Rating associated with image (G, PG, R, X)
  • alt_text: Alternative text description of image
  • selected: Whether image is currently selected
  • updated_date: Date and time when image was last updated

VerifiedAccount

A verified account on a user’s profile.

Properties:

  • service_type: Type of service
  • service_label: Name of service
  • service_icon: URL to service’s icon
  • url: URL to user’s profile on service
  • is_hidden: Whether account is hidden from profile

A link added to a user’s profile.

Properties:

  • label: Label for the link
  • url: URL to the link

Interest

An interest added to a user’s profile.

Properties:

  • id: Unique identifier for interest
  • name: Name of interest

Returns a list of inferred interests based on known and public information about the profile.

Endpoint: GET /profiles/{profileIdentifier}/inferred-interests

CryptoWalletAddress

A cryptocurrency wallet address the user accepts.

Properties:

  • label: Label for the cryptocurrency
  • address: Wallet address for the cryptocurrency

GalleryImage

A gallery image a user has uploaded.

Properties:

  • url: The URL to the image
  • alt_text: The image alt text

Language

The languages the user knows.

Properties:

  • code: The language code
  • name: The language name
  • is_primary: Whether the language is the user’s primary language

order: The order of the language in the user’s profile

OpenAPI Specifications (formerly Swagger)

Gravatar offers a machine-readable OpenAPI Specification (OAS) for API version 3.0.0

This specification provides a complete and standardized description of the Gravatar API, making it easy to explore, understand, and integrate with your own applications.

The complete API specification is available at:

https://api.gravatar.com/v3/openapi



Last updated on: