Controller: Account Management: GetContacts
GetContacts
This API call accepts filtering, see paging and filtering page.
The only filterable field is email, see the second example.
Authentication Methods
- With a username and password
Input Parameter | Type | Description |
---|---|---|
Token* | String | Security token |
Output Parameter | Type | Description |
---|---|---|
Account | Account | Account object containing the info about the passed account |
*Required
CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?&Token=6j839v049812he2nagmnt2bfr2&Task=GetContacts'
RESPONSE
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>20</TotalCount>
<Contacts>
<ContactInfo>
<Email>user1@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user2@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user3@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user4@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user5@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user6@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user7@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user8@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user9@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user10@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user11@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user12@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user13@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user14@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user15@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user16@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user17@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user18@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user19@example.com</Email>
</ContactInfo>
<ContactInfo>
<Email>user20@example.com</Email>
</ContactInfo>
</Contacts>
</Response>
CURL EXAMPLE with filtering
curl -v 'https://secure.nomadesk.com/ctrller/api.php?&Token=6j839v049812he2nagmnt2bfr2&Task=GetContacts&FilterBy=Email&FilterValue=testuser'
RESPONSE
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>3</TotalCount>
<Contacts>
<ContactInfo>
<Email>testuser001@nomadesk.com</Email>
</ContactInfo>
<ContactInfo>
<Email>testuser002@nomades.com</Email>
</ContactInfo>
<ContactInfo>
<Email>testuser999@nomadesk.omc</Email>
</ContactInfo>
</Contacts>
</Response>