AUautomattic
profiles

Get profile by identifier

Changed on

Returns a profile by the given identifier.

get/profiles/{profileIdentifier}

Request

Path parameters

profileIdentifierstring required

This can either be an SHA256 hash of an email address or profile URL slug.

Response

Successful response

user_idinteger

The unique user ID. NOTE: This is only provided in OAuth2 authenticated requests.

user_loginstring

The user's login name. NOTE: This is only provided in OAuth2 authenticated requests.

hashstring required

The SHA256 hash of the user's primary email address.

display_namestring required

The user's display name. This is the name that is displayed on their profile.

profile_urlstring uri required

The full URL for the user's profile.

avatar_urlstring uri required

The URL for the user's avatar image if it has been set.

avatar_alt_textstring required

The alt text for the user's avatar image if it has been set.

locationstring required

The user's location.

descriptionstring required

The about section on a user's profile.

job_titlestring required

The user's job title.

companystring required

The user's current company's name.

pronunciationstring required

The phonetic pronunciation of the user's name.

pronounsstring required

The pronouns the user uses.

timezonestring

The timezone the user has. This is only provided in authenticated API requests.

first_namestring

User's first name. This is only provided in authenticated API requests.

last_namestring

User's last name. This is only provided in authenticated API requests.

is_organizationboolean

Whether user is an organization. This is only provided in authenticated API requests.

header_imagestring

The header image used in the main profile card.

background_colorstring

The profile background color.

number_verified_accountsinteger

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.

last_profile_editstring date-time nullable

The date and time (UTC) the user last edited their profile. This is only provided in authenticated API requests.

registration_datestring date-time nullable

The date the user registered their account. This is only provided in authenticated API requests.

Example response

{
  "user_id": 1234567890,
  "user_login": "alex",
  "hash": "31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66",
  "display_name": "Alex Morgan",
  "profile_url": "https://gravatar.com/example",
  "avatar_url": "https://0.gravatar.com/avatar/33252cd1f33526af53580fcb1736172f06e6716f32afdd1be19ec3096d15dea5",
  "avatar_alt_text": "Alex Morgan's avatar image. Alex is smiling and standing in beside a large dog who is looking up at Alex.",
  "location": "New York, USA",
  "description": "I like playing hide and seek.",
  "job_title": "Landscape Architect",
  "company": "ACME Corp",
  "verified_accounts": [
    {
      "service_type": "tumblr",
      "service_label": "Tumblr",
      "service_icon": "https://gravatar.com/icons/tumblr-alt.svg",
      "url": "https://example.tumblr.com/"
    }
  ],
  "pronunciation": "Al-ex Mor-gan",
  "pronouns": "She/They",
  "timezone": "Europe/Bratislava",
  "languages": [
    {
      "code": "en",
      "name": "English",
      "is_primary": true,
      "order": 1
    }
  ],
  "first_name": "Alex",
  "last_name": "Morgan",
  "header_image": "url('https://gravatar.com/userimage/209234789/cdebd0ed415kfa2g562ba5c34b1570c2') no-repeat 50% 1% / 100%",
  "background_color": "rgb(33, 0, 166)",
  "links": [
    {
      "label": "Personal Website",
      "url": "https://example.com"
    }
  ],
  "interests": [
    {
      "id": 1,
      "name": "photography"
    }
  ],
  "payments": {
    "links": [
      {
        "label": "Personal Website",
        "url": "https://example.com"
      }
    ],
    "crypto_wallets": [
      {
        "label": "ETH",
        "address": "0xABC123..."
      }
    ]
  },
  "contact_info": {
    "home_phone": "+1-555-555-0100",
    "work_phone": "+1-555-555-0101",
    "cell_phone": "+1-555-555-0102",
    "email": "alex@example.com",
    "contact_form": "https://example.com/contact-me",
    "calendar": "https://example.com/calendar"
  },
  "gallery": [
    {
      "url": "https://0.gravatar.com/userimage/5/04bbd674f72c703f6335e2e7a00acc9a",
      "alt_text": "A beautiful sunset"
    }
  ],
  "number_verified_accounts": 3,
  "last_profile_edit": "2021-10-01T12:00:00Z",
  "registration_date": "2021-10-01T12:00:00Z"
}

Changes

  • d01551ae9a37Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0cfe4779525bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status