GET api/v1/Agents/{agentId}/Users?contactType={contactType}&addressbookId={addressbookId}
Find only ContactType=Customer contacts By AgentID
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| agentId |
Define this parameter in the request URI. |
|
| contactType |
Define this parameter in the request URI. |
|
| addressbookId |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
{
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
{
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
}
]
application/xml, text/xml
Sample:
<ArrayOfAgentContactDTO>
<AgentContactDTO>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</AgentContactDTO>
<AgentContactDTO>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</AgentContactDTO>
<AgentContactDTO>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</AgentContactDTO>
</ArrayOfAgentContactDTO>