👍

Required plan

Available only in the SOCIAL plan and up.

A handle/screen name/nick used to identify a user online. Note that even though in many sites the username uniquely identifies one person, it is not guaranteed. Some sites allow different people to use the same username.

Component

Type

Description

content

String

A person’s username at one or more online services.

📘

Know the service for the username?

  1. A username search allows for an optional @service suffix similar to the User ID format. The format to be used is [email protected], for example [email protected] See list of supported services.

  2. By prefixing a username with an @ symbol, the service is considered to be Twitter, for example @superman.

Search Requirements

For a username object to be sufficient for a search, its content attribute should have a string without whitespace with length >= 3.

Example

{
  "content": "superman"
}