{"id":5027,"date":"2014-02-11T12:57:41","date_gmt":"2014-02-11T18:57:41","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5027"},"modified":"2014-02-13T16:15:33","modified_gmt":"2014-02-13T22:15:33","slug":"viewing-contacts","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/contact-and-group-apis\/viewing-contacts\/","title":{"rendered":"Viewing Contacts"},"content":{"rendered":"\n\n\n\n\n\n
\n

Query Parameters<\/p>\n<\/td>\n

\n

limit=LIMIT<\/strong><\/p>\n

Limit the number of results to LIMIT. <\/p>\n

offset=OFFSET <\/strong><\/p>\n

Skip OFFSET entries from the start. Only valid when limit is specified.<\/p>\n

name=SUBSTR <\/strong><\/p>\n

fax_number=SUBSTR <\/strong><\/p>\n

phone_number=SUBSTR <\/strong><\/p>\n

organization=SUBSTR Search for contacts by field name. If you specify more than one, they are concatenated with AND.<\/p>\n

order=field name<\/strong> <\/p>\n

Sort contacts by field name. Not available for FFx30 models.<\/p>\n<\/td>\n<\/tr>\n

\n

HTTP Request Line<\/p>\n<\/td>\n

\n

GET \/ffws\/v1\/contacts\/USERNAME HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/contacts\/USERNAME\/ID HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/contacts\/global_contact_list HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/contacts\/global_contact_list\/ID HTTP\/1.1<\/p>\n<\/td>\n<\/tr>\n

\n

HTTP Response Status Codes<\/p>\n<\/td>\n

\n

200 OK<\/p>\n<\/td>\n

\n

Shows contact information.<\/p>\n<\/td>\n<\/tr>\n

\n

403 Forbidden<\/p>\n<\/td>\n

\n

Authenticated user does not have permission to view data.<\/p>\n<\/td>\n<\/tr>\n

\n

404 Not Found<\/p>\n<\/td>\n

\n

No user found with that username.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

Example<\/h4>\n
\r\nGET \/ffws\/v1\/contacts\/admin HTTP\/1.1\r\ncontent-type: application\/xml\r\nauthorization: Basic YWRtaW46YWRtaW4=\r\n-----------------------------------\r\nHTTP\/1.1 200 OK\r\ncontent-type: application\/xml\r\n<?xml version=\u201d1.0\u201d encoding=\u201dUTF-8\u201d?>\r\n<response>\r\n\t<message>Success<\/message>\r\n\t<contact>\r\n\t\t<contact_url>https:\/\/192.168.2.1\/ffws\/v1\/contacts\/admin\/3<\/contact_url>\r\n\t\t<name>Contact Name<\/name>\r\n\t\t<fax_number>218-555-3335<\/fax_number>\r\n\t\t<phone_number>218-555-3336<\/phone_number>\r\n\t\t<organization>Contacts Org<\/organization>\r\n\t<\/contact>\r\n<\/response>\r\n\r\n\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Query Parameters limit=LIMIT Limit the number of results to LIMIT. offset=OFFSET Skip OFFSET entries from the start. Only valid when limit is specified. name=SUBSTR fax_number=SUBSTR phone_number=SUBSTR organization=SUBSTR Search for contacts by field name. If you specify more than one, they are concatenated with AND. order=field name Sort contacts by field name. Not available for FFx30 […]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5406,"menu_order":24,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-5027","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5027","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/537"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=5027"}],"version-history":[{"count":11,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5027\/revisions"}],"predecessor-version":[{"id":5453,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5027\/revisions\/5453"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5406"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5027"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}