Users

List users

Returns a list of users in the organization, including both active users and invited users. When the email query parameter is provided, returns only the user matching that email address. If no user is found for the given email, an empty list is returned.

get/iam/v1/users

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/iam/v1/users
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Query parameters

emailstring email

Filter by exact email address. When provided, returns at most one user matching this email. The email is matched case-insensitively.

Response

OK - List of users returned.

rowCountinteger

The number of returned records.

Example response

{
  "rowCount": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.