Profile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gravatar/refs/heads/main/json-schema/profile.json",
  "title": "Profile",
  "type": "object",
  "description": "A user's profile information.",
  "required": [
    "hash",
    "display_name",
    "profile_url",
    "avatar_url",
    "avatar_alt_text",
    "location",
    "description",
    "job_title",
    "company",
    "verified_accounts",
    "pronunciation",
    "pronouns"
  ],
  "properties": {
    "user_id": {
      "type": "integer",
      "description": "The unique user ID. NOTE: This is only provided in OAuth2 authenticated requests.",
      "examples": [
        1234567890
      ]
    },
    "user_login": {
      "type": "string",
      "description": "The user's login name. NOTE: This is only provided in OAuth2 authenticated requests.",
      "examples": [
        "alex"
      ]
    },
    "hash": {
      "type": "string",
      "description": "The SHA256 hash of the user's primary email address.",
      "examples": [
        "31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66"
      ]
    },
    "display_name": {
      "type": "string",
      "description": "The user's display name. This is the name that is displayed on their profile.",
      "examples": [
        "Alex Morgan"
      ]
    },
    "profile_url": {
      "type": "string",
      "description": "The full URL for the user's profile.",
      "format": "uri",
      "examples": [
        "https://gravatar.com/example"
      ]
    },
    "avatar_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL for the user's avatar image if it has been set.",
      "examples": [
        "https://0.gravatar.com/avatar/33252cd1f33526af53580fcb1736172f06e6716f32afdd1be19ec3096d15dea5"
      ]
    },
    "avatar_alt_text": {
      "type": "string",
      "description": "The alt text for the user's avatar image if it has been set.",
      "examples": [
        "Alex Morgan's avatar image. Alex is smiling and standing in beside a large dog who is looking up at Alex."
      ]
    },
    "location": {
      "type": "string",
      "description": "The user's location.",
      "examples": [
        "New York, USA"
      ]
    },
    "description": {
      "type": "string",
      "description": "The about section on a user's profile.",
      "examples": [
        "I like playing hide and seek."
      ]
    },
    "job_title": {
      "type": "string",
      "description": "The user's job title.",
      "examples": [
        "Landscape Architect"
      ]
    },
    "company": {
      "type": "string",
      "description": "The user's current company's name.",
      "examples": [
        "ACME Corp"
      ]
    },
    "verified_accounts": {
      "type": "array",
      "description": "A list of verified accounts the user has added to their profile. This is limited to a max of 4 in unauthenticated requests.",
      "items": {
        "$ref": "#/components/schemas/VerifiedAccount"
      }
    },
    "pronunciation": {
      "type": "string",
      "description": "The phonetic pronunciation of the user's name.",
      "examples": [
        "Al-ex Mor-gan"
      ]
    },
    "pronouns": {
      "type": "string",
      "description": "The pronouns the user uses.",
      "examples": [
        "She/They"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "The timezone the user has. This is only provided in authenticated API requests.",
      "examples": [
        "Europe/Bratislava"
      ]
    },
    "languages": {
      "type": "array",
      "description": "The languages the user knows. This is only provided in authenticated API requests.",
      "items": {
        "$ref": "#/components/schemas/Language"
      }
    },
    "first_name": {
      "type": "string",
      "description": "User's first name. This is only provided in authenticated API requests.",
      "examples": [
        "Alex"
      ]
    },
    "last_name": {
      "type": "string",
      "description": "User's last name. This is only provided in authenticated API requests.",
      "examples": [
        "Morgan"
      ]
    },
    "is_organization": {
      "type": "boolean",
      "description": "Whether user is an organization. This is only provided in authenticated API requests.",
      "examples": [
        false
      ]
    },
    "header_image": {
      "type": "string",
      "description": "The header image used in the main profile card.",
      "examples": [
        "url('https://gravatar.com/userimage/209234789/cdebd0ed415kfa2g562ba5c34b1570c2') no-repeat 50% 1% / 100%"
      ]
    },
    "hide_default_header_image": {
      "type": "boolean",
      "description": "Whether to hide the default header image",
      "examples": [
        false
      ]
    },
    "background_color": {
      "type": "string",
      "description": "The profile background color.",
      "examples": [
        "rgb(33, 0, 166)",
        "linear-gradient(135deg, rgb(2, 3, 129) 0%, rgb(40, 116, 252) 100%)"
      ]
    },
    "links": {
      "type": "array",
      "description": "A list of links the user has added to their profile. This is only provided in authenticated API requests.",
      "items": {
        "$ref": "#/components/schemas/Link"
      }
    },
    "interests": {
      "type": "array",
      "description": "A list of interests the user has added to their profile. This is only provided in authenticated API requests.",
      "items": {
        "$ref": "#/components/schemas/Interest"
      }
    },
    "payments": {
      "type": "object",
      "required": [
        "links",
        "crypto_wallets"
      ],
      "description": "The user's public payment information. This is only provided in authenticated API requests.",
      "properties": {
        "links": {
          "type": "array",
          "description": "A list of payment URLs the user has added to their profile.",
          "items": {
            "$ref": "#/components/schemas/Link"
          }
        },
        "crypto_wallets": {
          "type": "array",
          "description": "A list of crypto currencies the user accepts.",
          "items": {
            "$ref": "#/components/schemas/CryptoWalletAddress"
          }
        }
      }
    },
    "contact_info": {
      "type": "object",
      "description": "The user's contact information. This is only available if the user has chosen to make it public. This is only provided in authenticated API requests.",
      "properties": {
        "home_phone": {
          "type": "string",
          "description": "The user's home phone number.",
          "examples": [
            "+1-555-555-0100"
          ]
        },
        "work_phone": {
          "type": "string",
          "description": "The user's work phone number.",
          "examples": [
            "+1-555-555-0101"
          ]
        },
        "cell_phone": {
          "type": "string",
          "description": "The user's cell phone number.",
          "examples": [
            "+1-555-555-0102"
          ]
        },
        "email": {
          "type": "string",
          "description": "The user's email address as provided on the contact section of the profile. Might differ from their account emails.",
          "format": "email",
          "examples": [
            "[email protected]"
          ]
        },
        "contact_form": {
          "type": "string",
          "description": "The URL to the user's contact form.",
          "format": "uri",
          "examples": [
            "https://example.com/contact-me"
          ]
        },
        "calendar": {
          "type": "string",
          "description": "The URL to the user's calendar.",
          "format": "uri",
          "examples": [
            "https://example.com/calendar"
          ]
        }
      }
    },
    "gallery": {
      "type": "array",
      "description": "Additional images a user has uploaded. This is only provided in authenticated API requests.",
      "items": {
        "$ref": "#/components/schemas/GalleryImage"
      }
    },
    "number_verified_accounts": {
      "type": "integer",
      "description": "The number of verified accounts the user has added to their profile. This count includes verified accounts the user is hiding from their profile. This is only provided in authenticated API requests.",
      "examples": [
        3
      ]
    },
    "last_profile_edit": {
      "type": [
        "string",
        "null"
      ],
      "nullable": true,
      "description": "The date and time (UTC) the user last edited their profile. This is only provided in authenticated API requests.",
      "format": "date-time",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
      "examples": [
        "2021-10-01T12:00:00Z"
      ]
    },
    "registration_date": {
      "type": [
        "string",
        "null"
      ],
      "nullable": true,
      "description": "The date the user registered their account. This is only provided in authenticated API requests.",
      "format": "date-time",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
      "examples": [
        "2021-10-01T12:00:00Z"
      ]
    },
    "section_visibility": {
      "type": "object",
      "description": "The visibility of the user's profile sections.",
      "properties": {
        "hidden_contact_info": {
          "type": "boolean",
          "description": "Whether the user's contact info section is hidden."
        },
        "hidden_feeds": {
          "type": "boolean",
          "description": "Whether the user's feeds section is hidden."
        },
        "hidden_links": {
          "type": "boolean",
          "description": "Whether the user's links section is hidden."
        },
        "hidden_interests": {
          "type": "boolean",
          "description": "Whether the user's interests section is hidden."
        },
        "hidden_wallet": {
          "type": "boolean",
          "description": "Whether the user's wallet section is hidden."
        },
        "hidden_photos": {
          "type": "boolean",
          "description": "Whether the user's photo gallery section is hidden."
        },
        "hidden_verified_accounts": {
          "type": "boolean",
          "description": "Whether the user's verified accounts section is hidden."
        }
      }
    }
  }
}