{"id":5057,"date":"2014-02-11T15:14:29","date_gmt":"2014-02-11T21:14:29","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5057"},"modified":"2014-02-13T16:15:41","modified_gmt":"2014-02-13T22:15:41","slug":"viewing-groups","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/contact-and-group-apis\/viewing-groups\/","title":{"rendered":"Viewing Groups"},"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

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

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

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

Sort groups 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\/contact_groups\/USERNAME HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/contact_groups\/global_contact_list 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 group information.<\/p>\n<\/td>\n<\/tr>\n

\n

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

\n

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

\n

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

\n

Groups not found for that user.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

Example<\/h4>\n
\r\nGET \/ffws\/v1\/contact_groups\/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_group>\r\n\t\t<contact_group_url>https:\/\/172.16.128.5\/ffws\/v1\/contact_groups\/admin\/4<\/contact_group_url>\r\n\t\t<name>g one<\/name>\r\n\t\t<description>g one<\/description>\r\n\t\t<contact>https:\/\/172.16.128.5\/ffws\/v1\/contacts\/admin\/1<\/contact>\r\n\t\t<contact>https:\/\/172.16.128.5\/ffws\/v1\/contacts\/admin\/2<\/contact>\r\n\t\t<contact>https:\/\/172.16.128.5\/ffws\/v1\/contacts\/global_contact_list\/3<\/contact>\r\n\t<\/contact_group>\r\n\t<contact_group>\r\n\t\t<contact_group_url>https:\/\/172.16.128.5\/ffws\/v1\/contact_groups\/admin\/6<\/contact_group_url>\r\n\t\t<name>g two<\/name>\r\n\t\t<description>g two org<\/description>\r\n\t\t<contact>https:\/\/172.16.128.5\/ffws\/v1\/contacts\/admin\/2<\/contact>\r\n\t\t<contact>https:\/\/172.16.128.5\/ffws\/v1\/contacts\/global_contact_list\/4<\/contact>\r\n\t<\/contact_group>\r\n<\/response>\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 description=SUBSTR Search for groups by field name. If you specify more than one, they are concatenated with AND. order=field name Sort groups by field name. Not available for FFx30 models. HTTP […]<\/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-5057","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5057","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=5057"}],"version-history":[{"count":7,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5057\/revisions"}],"predecessor-version":[{"id":5454,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5057\/revisions\/5454"}],"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=5057"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}