GET api/delegategroups/{delegateGroupId}/delegates/{offset}?count={count}&searchTerm={searchTerm}
Gets a paginated list of all delegates in a delegate group by id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| delegateGroupId |
The id of the delegate group |
integer |
Required |
| offset |
Pagination offset. Return results starting at this index. |
integer |
Default value is 0 |
| count |
Number of results to return. If a number greater than 0 is provided, the results will be paginated. |
integer |
Default value is 0 |
| searchTerm |
Search term used to filter the results. When a term is provided, searches are performed on first name, last name, username, and email. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Returns the delegates, or an empty list if the group was not found
Collection of DelegateInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| DelegateCount |
Gets or sets the total delegate count in the delegate group |
integer |
None. |
| Delegates |
Gets or sets the delegate list received as a part of group info |
Collection of Delegate |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"delegateCount": 1,
"delegates": [
{
"id": 1,
"delegateGroupId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"username": "sample string 6",
"email": "sample string 7",
"role": "sample string 8",
"comments": "sample string 9",
"addressComments": "sample string 10",
"securitySettings": {
"canBookSubscriptions": true,
"canBookTrips": true,
"canEditProfile": true,
"canViewProfile": true,
"canCancelTrips": true,
"canManagePassengerFeedback": true,
"canEditCasualTrips": true,
"canEditSubscriptionTrips": true,
"canTopUpAccount": true,
"canViewTransactionHistory": true,
"canPerformMileageReimbursementTrips": true,
"canBookMileageReimbursementTrips": true,
"canBookSubscriptionMileageReimbursementTrips": true
},
"canManageClients": true,
"canManageDelegates": true,
"canManageLocations": true,
"inheritGroupSecurity": true,
"dateCreated": "2025-12-10T06:34:25.6445521-07:00"
},
{
"id": 1,
"delegateGroupId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"username": "sample string 6",
"email": "sample string 7",
"role": "sample string 8",
"comments": "sample string 9",
"addressComments": "sample string 10",
"securitySettings": {
"canBookSubscriptions": true,
"canBookTrips": true,
"canEditProfile": true,
"canViewProfile": true,
"canCancelTrips": true,
"canManagePassengerFeedback": true,
"canEditCasualTrips": true,
"canEditSubscriptionTrips": true,
"canTopUpAccount": true,
"canViewTransactionHistory": true,
"canPerformMileageReimbursementTrips": true,
"canBookMileageReimbursementTrips": true,
"canBookSubscriptionMileageReimbursementTrips": true
},
"canManageClients": true,
"canManageDelegates": true,
"canManageLocations": true,
"inheritGroupSecurity": true,
"dateCreated": "2025-12-10T06:34:25.6445521-07:00"
}
]
},
{
"delegateCount": 1,
"delegates": [
{
"id": 1,
"delegateGroupId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"username": "sample string 6",
"email": "sample string 7",
"role": "sample string 8",
"comments": "sample string 9",
"addressComments": "sample string 10",
"securitySettings": {
"canBookSubscriptions": true,
"canBookTrips": true,
"canEditProfile": true,
"canViewProfile": true,
"canCancelTrips": true,
"canManagePassengerFeedback": true,
"canEditCasualTrips": true,
"canEditSubscriptionTrips": true,
"canTopUpAccount": true,
"canViewTransactionHistory": true,
"canPerformMileageReimbursementTrips": true,
"canBookMileageReimbursementTrips": true,
"canBookSubscriptionMileageReimbursementTrips": true
},
"canManageClients": true,
"canManageDelegates": true,
"canManageLocations": true,
"inheritGroupSecurity": true,
"dateCreated": "2025-12-10T06:34:25.6445521-07:00"
},
{
"id": 1,
"delegateGroupId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"username": "sample string 6",
"email": "sample string 7",
"role": "sample string 8",
"comments": "sample string 9",
"addressComments": "sample string 10",
"securitySettings": {
"canBookSubscriptions": true,
"canBookTrips": true,
"canEditProfile": true,
"canViewProfile": true,
"canCancelTrips": true,
"canManagePassengerFeedback": true,
"canEditCasualTrips": true,
"canEditSubscriptionTrips": true,
"canTopUpAccount": true,
"canViewTransactionHistory": true,
"canPerformMileageReimbursementTrips": true,
"canBookMileageReimbursementTrips": true,
"canBookSubscriptionMileageReimbursementTrips": true
},
"canManageClients": true,
"canManageDelegates": true,
"canManageLocations": true,
"inheritGroupSecurity": true,
"dateCreated": "2025-12-10T06:34:25.6445521-07:00"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfDelegateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
<DelegateInfo>
<DelegateCount>1</DelegateCount>
<Delegates>
<Delegate>
<AddressComments>sample string 10</AddressComments>
<CanManageClients>true</CanManageClients>
<CanManageDelegates>true</CanManageDelegates>
<CanManageLocations>true</CanManageLocations>
<Comments>sample string 9</Comments>
<DateCreated>2025-12-10T06:34:25.6445521-07:00</DateCreated>
<DelegateGroupId>2</DelegateGroupId>
<Email>sample string 7</Email>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<InheritGroupSecurity>true</InheritGroupSecurity>
<LastName>sample string 4</LastName>
<Phone>sample string 5</Phone>
<Role>sample string 8</Role>
<SecuritySettings>
<CanBookMileageReimbursementTrips>true</CanBookMileageReimbursementTrips>
<CanBookSubscriptionMileageReimbursementTrips>true</CanBookSubscriptionMileageReimbursementTrips>
<CanBookSubscriptions>true</CanBookSubscriptions>
<CanBookTrips>true</CanBookTrips>
<CanCancelTrips>true</CanCancelTrips>
<CanEditCasualTrips>true</CanEditCasualTrips>
<CanEditProfile>true</CanEditProfile>
<CanEditSubscriptionTrips>true</CanEditSubscriptionTrips>
<CanManagePassengerFeedback>true</CanManagePassengerFeedback>
<CanPerformMileageReimbursementTrips>true</CanPerformMileageReimbursementTrips>
<CanTopUpAccount>true</CanTopUpAccount>
<CanViewProfile>true</CanViewProfile>
<CanViewTransactionHistory>true</CanViewTransactionHistory>
</SecuritySettings>
<Username>sample string 6</Username>
</Delegate>
<Delegate>
<AddressComments>sample string 10</AddressComments>
<CanManageClients>true</CanManageClients>
<CanManageDelegates>true</CanManageDelegates>
<CanManageLocations>true</CanManageLocations>
<Comments>sample string 9</Comments>
<DateCreated>2025-12-10T06:34:25.6445521-07:00</DateCreated>
<DelegateGroupId>2</DelegateGroupId>
<Email>sample string 7</Email>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<InheritGroupSecurity>true</InheritGroupSecurity>
<LastName>sample string 4</LastName>
<Phone>sample string 5</Phone>
<Role>sample string 8</Role>
<SecuritySettings>
<CanBookMileageReimbursementTrips>true</CanBookMileageReimbursementTrips>
<CanBookSubscriptionMileageReimbursementTrips>true</CanBookSubscriptionMileageReimbursementTrips>
<CanBookSubscriptions>true</CanBookSubscriptions>
<CanBookTrips>true</CanBookTrips>
<CanCancelTrips>true</CanCancelTrips>
<CanEditCasualTrips>true</CanEditCasualTrips>
<CanEditProfile>true</CanEditProfile>
<CanEditSubscriptionTrips>true</CanEditSubscriptionTrips>
<CanManagePassengerFeedback>true</CanManagePassengerFeedback>
<CanPerformMileageReimbursementTrips>true</CanPerformMileageReimbursementTrips>
<CanTopUpAccount>true</CanTopUpAccount>
<CanViewProfile>true</CanViewProfile>
<CanViewTransactionHistory>true</CanViewTransactionHistory>
</SecuritySettings>
<Username>sample string 6</Username>
</Delegate>
</Delegates>
</DelegateInfo>
<DelegateInfo>
<DelegateCount>1</DelegateCount>
<Delegates>
<Delegate>
<AddressComments>sample string 10</AddressComments>
<CanManageClients>true</CanManageClients>
<CanManageDelegates>true</CanManageDelegates>
<CanManageLocations>true</CanManageLocations>
<Comments>sample string 9</Comments>
<DateCreated>2025-12-10T06:34:25.6445521-07:00</DateCreated>
<DelegateGroupId>2</DelegateGroupId>
<Email>sample string 7</Email>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<InheritGroupSecurity>true</InheritGroupSecurity>
<LastName>sample string 4</LastName>
<Phone>sample string 5</Phone>
<Role>sample string 8</Role>
<SecuritySettings>
<CanBookMileageReimbursementTrips>true</CanBookMileageReimbursementTrips>
<CanBookSubscriptionMileageReimbursementTrips>true</CanBookSubscriptionMileageReimbursementTrips>
<CanBookSubscriptions>true</CanBookSubscriptions>
<CanBookTrips>true</CanBookTrips>
<CanCancelTrips>true</CanCancelTrips>
<CanEditCasualTrips>true</CanEditCasualTrips>
<CanEditProfile>true</CanEditProfile>
<CanEditSubscriptionTrips>true</CanEditSubscriptionTrips>
<CanManagePassengerFeedback>true</CanManagePassengerFeedback>
<CanPerformMileageReimbursementTrips>true</CanPerformMileageReimbursementTrips>
<CanTopUpAccount>true</CanTopUpAccount>
<CanViewProfile>true</CanViewProfile>
<CanViewTransactionHistory>true</CanViewTransactionHistory>
</SecuritySettings>
<Username>sample string 6</Username>
</Delegate>
<Delegate>
<AddressComments>sample string 10</AddressComments>
<CanManageClients>true</CanManageClients>
<CanManageDelegates>true</CanManageDelegates>
<CanManageLocations>true</CanManageLocations>
<Comments>sample string 9</Comments>
<DateCreated>2025-12-10T06:34:25.6445521-07:00</DateCreated>
<DelegateGroupId>2</DelegateGroupId>
<Email>sample string 7</Email>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<InheritGroupSecurity>true</InheritGroupSecurity>
<LastName>sample string 4</LastName>
<Phone>sample string 5</Phone>
<Role>sample string 8</Role>
<SecuritySettings>
<CanBookMileageReimbursementTrips>true</CanBookMileageReimbursementTrips>
<CanBookSubscriptionMileageReimbursementTrips>true</CanBookSubscriptionMileageReimbursementTrips>
<CanBookSubscriptions>true</CanBookSubscriptions>
<CanBookTrips>true</CanBookTrips>
<CanCancelTrips>true</CanCancelTrips>
<CanEditCasualTrips>true</CanEditCasualTrips>
<CanEditProfile>true</CanEditProfile>
<CanEditSubscriptionTrips>true</CanEditSubscriptionTrips>
<CanManagePassengerFeedback>true</CanManagePassengerFeedback>
<CanPerformMileageReimbursementTrips>true</CanPerformMileageReimbursementTrips>
<CanTopUpAccount>true</CanTopUpAccount>
<CanViewProfile>true</CanViewProfile>
<CanViewTransactionHistory>true</CanViewTransactionHistory>
</SecuritySettings>
<Username>sample string 6</Username>
</Delegate>
</Delegates>
</DelegateInfo>
</ArrayOfDelegateInfo>