Search For Users (Company)

GraphQL endpoint: /company

Searches for users by name or username, email, telephone number, or metadata. Matches and returned fields respect each user's visibility settings, so fields hidden from the caller come back null (or empty for lists).

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

{}

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
          }
        ]
      },
      {
        "aboutMe": "this is my generic intro",
        "aboutMeVisibility": null,
        "addresses": [
          {
            "city": "test city",
            "country": "United States",
            "state": "Alabama",
            "street": "test street 8",
            "types": [
              "HOME"
            ],
            "visibility": null,
            "zipCode": "12345"
          }
        ],
        "birthdate": "1990-01-15",
        "birthdateVisibility": null,
        "emails": [
          {
            "email": "[e-mail]",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "firstName": "3john",
        "id": "00000000-0000-4000-8000-000000000002",
        "interests": [
          {
            "description": null,
            "title": "Interest 10"
          }
        ],
        "interestsVisibility": null,
        "lastName": "4doe",
        "metadata": {
          "test": "value"
        },
        "metadataVisibility": null,
        "middleName": "ray",
        "nameVisibility": null,
        "socialNetworks": [
          {
            "type": "FACEBOOK",
            "url": "https://test-sm11.not",
            "visibility": null
          }
        ],
        "telephoneNumbers": [
          {
            "number": "12",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "timezone": "UTC",
        "timezoneVisibility": null,
        "username": "username13",
        "webpages": [
          {
            "type": "WEBPAGE",
            "url": "https://test-webpage14.not",
            "visibility": null
          }
        ]
      },
      {
        "aboutMe": "this is my generic intro",
        "aboutMeVisibility": null,
        "addresses": [
          {
            "city": "test city",
            "country": "United States",
            "state": "Alabama",
            "street": "test street 15",
            "types": [
              "HOME"
            ],
            "visibility": null,
            "zipCode": "12345"
          }
        ],
        "birthdate": "1990-01-15",
        "birthdateVisibility": null,
        "emails": [
          {
            "email": "[e-mail]",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "firstName": "5john",
        "id": "00000000-0000-4000-8000-000000000003",
        "interests": [
          {
            "description": null,
            "title": "Interest 17"
          }
        ],
        "interestsVisibility": null,
        "lastName": "6doe",
        "metadata": {
          "test": "value"
        },
        "metadataVisibility": null,
        "middleName": "ray",
        "nameVisibility": null,
        "socialNetworks": [
          {
            "type": "FACEBOOK",
            "url": "https://test-sm18.not",
            "visibility": null
          }
        ],
        "telephoneNumbers": [
          {
            "number": "19",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "timezone": "UTC",
        "timezoneVisibility": null,
        "username": "username20",
        "webpages": [
          {
            "type": "WEBPAGE",
            "url": "https://test-webpage21.not",
            "visibility": null
          }
        ]
      },
      {
        "aboutMe": "this is my generic intro",
        "aboutMeVisibility": null,
        "addresses": [
          {
            "city": "test city",
            "country": "United States",
            "state": "Alabama",
            "street": "test street 22",
            "types": [
              "HOME"
            ],
            "visibility": null,
            "zipCode": "12345"
          }
        ],
        "birthdate": "1990-01-15",
        "birthdateVisibility": null,
        "emails": [
          {
            "email": "[e-mail]",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "firstName": "7john",
        "id": "00000000-0000-4000-8000-000000000004",
        "interests": [
          {
            "description": null,
            "title": "Interest 24"
          }
        ],
        "interestsVisibility": null,
        "lastName": "8doe",
        "metadata": {
          "test": "value"
        },
        "metadataVisibility": null,
        "middleName": "ray",
        "nameVisibility": null,
        "socialNetworks": [
          {
            "type": "FACEBOOK",
            "url": "https://test-sm25.not",
            "visibility": null
          }
        ],
        "telephoneNumbers": [
          {
            "number": "26",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "timezone": "UTC",
        "timezoneVisibility": null,
        "username": "username27",
        "webpages": [
          {
            "type": "WEBPAGE",
            "url": "https://test-webpage28.not",
            "visibility": null
          }
        ]
      },
      {
        "aboutMe": "this is my generic intro",
        "aboutMeVisibility": null,
        "addresses": [
          {
            "city": "test city",
            "country": "United States",
            "state": "Alabama",
            "street": "test street 29",
            "types": [
              "HOME"
            ],
            "visibility": null,
            "zipCode": "12345"
          }
        ],
        "birthdate": "1990-01-15",
        "birthdateVisibility": null,
        "emails": [
          {
            "email": "[e-mail]",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "firstName": "9john",
        "id": "00000000-0000-4000-8000-000000000005",
        "interests": [
          {
            "description": null,
            "title": "Interest 31"
          }
        ],
        "interestsVisibility": null,
        "lastName": "10doe",
        "metadata": {
          "test": "value"
        },
        "metadataVisibility": null,
        "middleName": "ray",
        "nameVisibility": null,
        "socialNetworks": [
          {
            "type": "FACEBOOK",
            "url": "https://test-sm32.not",
            "visibility": null
          }
        ],
        "telephoneNumbers": [
          {
            "number": "33",
            "types": [
              "OTHER"
            ],
            "visibility": null
          }
        ],
        "timezone": "UTC",
        "timezoneVisibility": null,
        "username": "username34",
        "webpages": [
          {
            "type": "WEBPAGE",
            "url": "https://test-webpage35.not",
            "visibility": null
          }
        ]
      }
    ]
  }
}