GET v1/Agents?Id={Id}&Name={Name}&ParentId={ParentId}&ParentName={ParentName}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Retrieve agents

Request Information

URI Parameters

Name	Description	Type	Additional information
Id		string	None.
Name		string	None.
ParentId		string	None.
ParentName		string	None.
Limit	Maximum number of records to return	integer	Range: inclusive between 1 and 2147483647
Offset	Number of records to skip during search, useful for pagination	integer	Range: inclusive between 0 and 2147483647
Total	Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets.	boolean	None.
SortDirection	Direction of sort: Ascending or Descending	SortDirection	None.
Sort	Comma separated list of field names to sort by	string	None.
Expand	Comma separated list of expansions to include in results	string	None.

Body Parameters

None.

Response Information

Resource Description

AgentListResponse

Name	Description	Type	Additional information
Limit	Echoed limit of request	integer	None.
Offset	Echoed offset of request	integer	None.
Total	Total records matching search, if requested	integer	None.
Data	List of records matching the search	Collection of AgentOutboundDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "InactiveDate": "2024-10-12T00:31:20.9400081-10:00",
      "ParentName": "sample string 3",
      "UserName": "sample string 4",
      "Address": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "ParentId": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "InactiveDate": "2024-10-12T00:31:20.9400081-10:00",
      "ParentName": "sample string 3",
      "UserName": "sample string 4",
      "Address": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "ParentId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<AgentListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Data>
    <AgentOutboundDTO>
      <Id>1</Id>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1 i:nil="true" />
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Type>Unknown</d4p1:Type>
      </Address>
      <InactiveDate>2024-10-12T00:31:20.9400081-10:00</InactiveDate>
      <Name>sample string 2</Name>
      <ParentId>1</ParentId>
      <ParentName>sample string 3</ParentName>
      <UserName>sample string 4</UserName>
    </AgentOutboundDTO>
    <AgentOutboundDTO>
      <Id>1</Id>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1 i:nil="true" />
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Type>Unknown</d4p1:Type>
      </Address>
      <InactiveDate>2024-10-12T00:31:20.9400081-10:00</InactiveDate>
      <Name>sample string 2</Name>
      <ParentId>1</ParentId>
      <ParentName>sample string 3</ParentName>
      <UserName>sample string 4</UserName>
    </AgentOutboundDTO>
  </Data>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <Total>1</Total>
</AgentListResponse>