GET /users
Gets a list of users in the organization account. To filter by email, use the optional email query string parameter to specify a list of users' email addresses.
NOTE: If the API request is submitted by a system administrator, the following User object attributes are included in the response (else, they are omitted from the response):
- admin
- groupAdmin
- licensedSheetCreator
- resourceViewer
- sheetCount (omitted if the status attribute is not ACTIVE)
- status
NOTE: If the API request is submitted by a system administrator of an Enterprise account, and Custom Welcome Screen is enabled, the following User object attributes are included in the response (else, they are omitted from the response):
- customWelcomeScreenViewed (omitted if the user has never viewed the Custom Welcome Screen)
Servers
- https://api.smartsheet.com/2.0
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | No |
Comma-separated list of email addresses on which to filter the results. |
include |
String | No |
If the API request is submitted by a system administrator and when specified with a value of 'lastLogin', response includes a lastLogin attribute for each user that indicates the Last login date/time of the user. Note If the number of users included in the response is > 100, you must paginate your query to see the lastLogin attribute. For large responses, the lastLogin attribute is never included. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.