Search users' email addresses

3 parameters

qstringoptional

The optional keyword used to search users' email addresses.

pageintegeroptional

The 1-based page number of matching email results to return.

limitintegeroptional

The number of matching email results to return per page.

2 status codes

200Returns an array of matching email objects containing each address, its primary and verified status, the associated user ID, and username.

emailstringoptional

primarybooleanoptional

user_idintegeroptional

usernamestringoptional

verifiedbooleanoptional

403Returned when the authenticated user is not permitted to search users' email addresses.

messagestringoptional

urlstringoptional

Error handling

A 403 is returned when the authenticated user does not have permission to search users' email addresses. page and limit must be integer values when supplied.

val client = Client(baseUrl = "https://api.acme.com")

val result = client.search.list(
    "keyword",
    1,
    20
)

[
  {
    "email": "user@example.com",
    "primary": true,
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "username": "janedoe",
    "verified": true
  }
]

Request

Response

Errors