Search For Users (User)

GraphQL endpoint: /user

Searches for users by name (username or full name), email, telephone number, or metadata. Only users whose matched field is visible to the caller are returned, and each returned profile is filtered by the same visibility rules.

Query

query (
  $name: String
  $email: String
  $telephoneNumber: String
  $limit: Int
  $metadata: JSON
) {
  users (
    name: $name
    email: $email
    telephoneNumber: $telephoneNumber
    limit: $limit
    metadata: $metadata
  ) {
    id
    username
    firstName
    middleName
    lastName
    birthdate
    aboutMe
    timezone
    metadata
    addresses {
      city
      country
      state
      street
      types
      zipCode
      visibility
    }
    emails {
      email
      types
      visibility
    }
    telephoneNumbers {
      number
      types
      visibility
    }
    socialNetworks {
      type
      url
      visibility
    }
    webpages {
      type
      url
      visibility
    }
    interests {
      description
      title
    }
    nameVisibility
    aboutMeVisibility
    birthdateVisibility
    interestsVisibility
    timezoneVisibility
    metadataVisibility
  }
}

Variables

{
  "name": "1john 2doe"
}

Response

{
  "data": {
    "users": [
      {
        "aboutMe": "this is my generic intro",
        "aboutMeVisibility": null,
        "addresses": [
          {
            "city": "test city",
            "country": "United States",
            "state": "Alabama",
            "street": "test street 1",
            "types": [
              "HOME"
            ],
            "visibility": null,
            "zipCode": "12345"
          }
        ],
        "birthdate": "1990-01-15",
        "birthdateVisibility": null,
        "emails": [
          {
            "email": "[e-mail]",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "firstName": "1john",
        "id": "00000000-0000-4000-8000-000000000001",
        "interests": [
          {
            "description": null,
            "title": "Interest 3"
          }
        ],
        "interestsVisibility": null,
        "lastName": "2doe",
        "metadata": {
          "test": "value"
        },
        "metadataVisibility": null,
        "middleName": "ray",
        "nameVisibility": null,
        "socialNetworks": [
          {
            "type": "FACEBOOK",
            "url": "https://test-sm4.not",
            "visibility": null
          }
        ],
        "telephoneNumbers": [
          {
            "number": "5",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "timezone": "UTC",
        "timezoneVisibility": null,
        "username": "username6",
        "webpages": [
          {
            "type": "WEBPAGE",
            "url": "https://test-webpage7.not",
            "visibility": null
          }
        ]
      }
    ]
  }
}