Get Users

List users in account

GET/v1/users

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Users action (under management).
Fill in the fields below, then reference the result from later steps as {{getUsers.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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

Returns 200 with an object. Read it in later steps with {{getUsers.response.data.<field>}}.

totalResultSizeinteger (int64)

dataarray<object>

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

modifiedstring (date-time)required

The time this entity was last modified.

emailstring (email)required

The email address associated with the user profile.

accountIdinteger (int64)required

The ID of the account that owns this entity.

namestringrequired

Name of the user.

statestringrequired

State of the user.

One ofinvitedactivedeactivated

inviteTokenstringrequired

Invitation token of the user. **Note**: If the user has already accepted their invitation, this is `null`.

isAdminboolean

Indicates whether the user is an `admin`.

policyobjectrequired

Access level of the user.

rolesarray<integer (int64)>

A list of the IDs of the roles assigned to the user.

authMethodstring

Authentication method for this user.

applicationNotificationSubscriptionsobject

Application notifications that the user is subscribed to.

lastSignedInstring (date-time)

Timestamp when the user last signed in to Talon.One.

lastAccessedstring (date-time)

Timestamp of the user's last activity after signing in to Talon.One.

latestFeedTimestampstring (date-time)

Timestamp when the user was notified for feed.

additionalAttributesobject

Additional user attributes, created and used by external identity providers.

json

{
  "totalResultSize": 1,
  "data": [
    {
      "created": {},
      "roles": [
        71
      ],
      "isAdmin": false,
      "accountId": 3886,
      "applicationNotificationSubscriptions": {},
      "inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
      "name": "John Doe",
      "modified": {},
      "lastAccessed": {},
      "id": 6,
      "state": "invited",
      "authMethod": "basic_auth",
      "latestFeedTimestamp": {},
      "lastSignedIn": {},
      "email": "john.doe@example.com",
      "policy": {
        "Role": 127
      },
      "additionalAttributes": {}
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?