GET api/v{version}/delegates/{delegateId}?includeDeleted={includeDeleted}

Gets a delegate by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateId

The id of the delegate to get.

integer

Required

includeDeleted

Whether to include the delegate if it has been deleted

boolean

Default value is False

version

The requested API version

string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns the delegate's basic information and security rights.

Delegate
NameDescriptionTypeAdditional information
Id

The delegate's id.

integer

None.

TenantId

The ID of the Tenant that the group belongs to.

integer

None.

GroupAssociations

The list of delegate groups associated with this delegate.

Collection of DelegateGroupDelegate

None.

FirstName

The first name of the delegate.

string

None.

LastName

The last name of the delegate.

string

None.

Phone

The delegate's phone number.

string

None.

Username

The username that the delegate uses to log in to the system.

string

None.

Email

The delegate's email address.

string

None.

Comments

Gets or sets optional comments for the delegate.

string

None.

AddressComments

Gets or sets optional address comments for the delegate. This is helpful for situations where the delegate is a part of a Facility group but is working from a different branch or location.

string

None.

DateCreated

Gets or sets the date on which delegate was created

date

None.

Response Formats

application/json, text/json, application/problem+json

Sample:
{
  "id": 1,
  "tenantId": 2,
  "groupAssociations": [
    {
      "delegateGroupId": 1,
      "delegateId": 2,
      "role": "sample string 3",
      "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
    },
    {
      "delegateGroupId": 1,
      "delegateId": 2,
      "role": "sample string 3",
      "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
    }
  ],
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "phone": "sample string 5",
  "username": "sample string 6",
  "email": "sample string 7",
  "comments": "sample string 8",
  "addressComments": "sample string 9",
  "dateCreated": "2026-07-17T14:15:37.3042598-04:00"
}

application/xml, text/xml

Sample:
<Delegate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <AddressComments>sample string 9</AddressComments>
  <Comments>sample string 8</Comments>
  <DateCreated>2026-07-17T14:15:37.3042598-04:00</DateCreated>
  <Email>sample string 7</Email>
  <FirstName>sample string 3</FirstName>
  <GroupAssociations>
    <DelegateGroupDelegate>
      <CanManageClients>true</CanManageClients>
      <CanManageDelegates>true</CanManageDelegates>
      <CanManageLocations>true</CanManageLocations>
      <DelegateGroupId>1</DelegateGroupId>
      <DelegateId>2</DelegateId>
      <InheritGroupSecurity>true</InheritGroupSecurity>
      <Role>sample string 3</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>
    </DelegateGroupDelegate>
    <DelegateGroupDelegate>
      <CanManageClients>true</CanManageClients>
      <CanManageDelegates>true</CanManageDelegates>
      <CanManageLocations>true</CanManageLocations>
      <DelegateGroupId>1</DelegateGroupId>
      <DelegateId>2</DelegateId>
      <InheritGroupSecurity>true</InheritGroupSecurity>
      <Role>sample string 3</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>
    </DelegateGroupDelegate>
  </GroupAssociations>
  <Id>1</Id>
  <LastName>sample string 4</LastName>
  <Phone>sample string 5</Phone>
  <TenantId>2</TenantId>
  <Username>sample string 6</Username>
</Delegate>