Get Organization users by email
POST https://{{base_url}}/v3/organizations/{{organization_uid}}/share/search
The Get Organization users by email request retrieves information about users within an organization based on their email addresses.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.
Read more about it in Authentication.
For more information, refer to the Get Organization users by email API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include_roles | boolean | The include_roles parameter, when set to “true,” will display the details of the roles that are assigned to the organization users. | |
include_user_details | boolean | The include_user_details parameter, when set to “true,” lets you know whether the user has enabled Two-factor Authentication or not. | |
include_count | boolean | The include_count parameter returns the total number of organization users. Example: If you wish to know the total number of organization invitations, you need to mention “true.” | |
limit | boolean | The limit parameter will return a specific number of organization users in your output. Example, if you want to retrieve details of 10 users and you wish to fetch only the first 5, you need to specify “5” as the value in this parameter. | |
skip | boolean | The skip parameter will skip a specific number of organization users in your output. Example, if you want to retrieve details of 10 users and you wish to skip the latest 5, you need to specify “5” as the value in this parameter. |
Request Body
{"emails"=>["abc@sample.com"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
authtoken | string | Enter your authtoken. | |
Content-Type | string |