GET api/v1/Teams/{id}/SessionUsers
Get all of the session users for a team
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The team ID |
globally unique identifier |
Required |
q |
A query parameter. Use this to limit the result set. ?q[fieldName1]=value1&q[fieldName2]=value2 |
Dictionary of string [key] and string [value] |
None. |
limit |
The number of records returned, default is 20 |
integer |
None. |
offset |
The offset from the start of the list of values, default is 0 |
integer |
None. |
orderBy |
Orders the list that comes down to the field name provided. If not provided then the default ordering will be used. |
string |
None. |
fields |
Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned. |
Collection of string |
None. |
suppressResponseCodes |
Some applications do wonky things if error codes are used. Use this to force 200s to always return. |
boolean |
None. |
APIKey |
This is your unique key that identifies you as the developer of this app. Required for all calls. |
string |
None. |
APIToken |
This is the user's session token generated when you authenticate the user |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
PaginatedResultsOfTeamMemberName | Description | Type | Additional information |
---|---|---|---|
limit | integer |
None. |
|
offset | integer |
None. |
|
totalRecordCount | integer |
None. |
|
data | Collection of TeamMember |
None. |
Response Formats
application/json, text/json
{ "limit": 1, "offset": 2, "totalRecordCount": 3, "data": [ { "TeamID": "e19cc0d4-c259-4c2f-8c78-43e6d11f7661", "IsLeader": true, "IsObserver": true, "Order": 4, "UserID": "6b5e999b-e079-4e25-8ce3-701752f5df72", "FirstName": "sample string 6", "LastName": "sample string 7", "ImageURL": "sample string 8", "loginName": "sample string 9", "ImageSettings": "sample string 10", "IsDeleted": true }, { "TeamID": "e19cc0d4-c259-4c2f-8c78-43e6d11f7661", "IsLeader": true, "IsObserver": true, "Order": 4, "UserID": "6b5e999b-e079-4e25-8ce3-701752f5df72", "FirstName": "sample string 6", "LastName": "sample string 7", "ImageURL": "sample string 8", "loginName": "sample string 9", "ImageSettings": "sample string 10", "IsDeleted": true } ] }