GET
/
hubs
/
{hub_id}
/
users

Path Parameters

hub_id
string
required

Query Parameters

first
integer
default: 20
before
string
after
string
search
string

Search is a string that is used to filter the list of End Users. The search string is matched against the id, externalId and displayName fields.

Response

200 - application/json
totalCount
integer
required
next
string
prev
string
users
object[]
required
users.id
string
required

ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.

users.externalId
string
required

ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must be unique within the Hub.

users.displayName
string
required

DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.

users.hubId
string
required

The hub ID to which the user belongs to.

users.createdAt
string
required

CreatedAt is the time the user was created.

users.updatedAt
string
required

UpdatedAt is the time the user was last updated.