Get addressbooks list

Retrieve a list of Contact Lists, as defined per user, to which batches may be sent.

GET /outbound/addressbooks[?limit={number}&offset={number}]

Arguments

Name (bold if mandatory) Type Comments Default
limit number How many items to return. 25
offset string Skip this many items in the list. 0

Response

If successful, an outbound fax structure is returned that includes the following properties:

Name Type Description
ContactListID Number The contact list ID
isPrivate Boolean true = this list is visible to the owning user only. false = this list is shared with all account users.
listName String A name for the list
userId String The list owner.
numOfContacts Number Number of recipients in the list.

Samples

Raw HTTP


GET /outbound/addressbooks HTTP/1.1
Host: rest.interfax.net
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

cURL

Get addressbooks list


curl "https://rest.interfax.net/outbound/addressbooks" ^
	-u username:password

Sample response (prettified for display here)


{"ContactListID":2147483647,"isPrivate":false,"listName":"GuyTest","userID":"fh_lior","numOfContacts":2},
{"ContactListID":2147485,"isPrivate":false,"listName":"liraz","userID":"liraz","numOfContacts":2},
{"ContactListID":22847,"isPrivate":false,"listName":"YNOT","userID":"eyalnevo","numOfContacts":49},
{"ContactListID":383647,"isPrivate":false,"listName":"UKtest","userID":"eyalnevo","numOfContacts":199},