Accounts and users
List users in account
[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.
Retrieve all users in your account.
get/v1/users
Request
- Base URLhttps://yourbaseurl.talon.one
- Auth
- API key in header Authorization
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageSizeinteger
The number of items in the response.
skipinteger
The number of items to skip when paging through large result sets.
sortstring
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.
Note: You may not be able to use all fields for sorting. This is due to performance limitations.
Response
OK
Example response
{
"totalResultSize": 1,
"data": [
{
"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"modified": "2021-09-12T10:12:42Z",
"email": "john.doe@example.com",
"accountId": 3886,
"name": "John Doe",
"state": "invited",
"inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
"policy": {
"Role": 127,
"Applications": null
},
"roles": [
71
],
"authMethod": "basic_auth",
"applicationNotificationSubscriptions": {},
"lastSignedIn": "2021-09-12T10:12:42Z",
"lastAccessed": "2021-09-12T10:14:42Z",
"latestFeedTimestamp": "2020-06-01T00:00:00Z",
"additionalAttributes": {}
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.