Users - Users Get

Get Users
Lists all users within the connected blockchain consortium.

GET /api/v2/users
GET /api/v2/users?top={top}&skip={skip}&externalId={externalId}&userChainIdentifier={userChainIdentifier}&sortBy={sortBy}

URI Parameters

Name In Required Type Description
top
query
  • integer
int32

The maximum number of items to return.

skip
query
  • integer
int32

The number of items to skip before returning.

externalId
query
  • string

The external ID of the user to query for.

userChainIdentifier
query
  • string

The on-chain address of the user to query for.

sortBy
query
  • string

The field to sort

Responses

Name Type Description
200 OK

OK

204 No Content

No Content

Definitions

User
UserChainMapping
UserList

User

Name Type Description
emailAddress
  • string
externalID
  • string
firstName
  • string
lastName
  • string
userChainMappings
userID
  • integer

UserChainMapping

Name Type Description
chainBalance
  • number
chainIdentifier
  • string
connectionID
  • integer
userChainMappingID
  • integer
userID
  • integer

UserList

Name Type Description
nextLink
  • string
users