{"id":50,"date":"2016-01-26T00:38:32","date_gmt":"2016-01-26T00:38:32","guid":{"rendered":"http:\/\/192.168.114.129\/?page_id=50"},"modified":"2023-06-24T11:10:16","modified_gmt":"2023-06-24T11:10:16","slug":"get-organizations","status":"publish","type":"page","link":"https:\/\/api-users.4over.com\/?page_id=50","title":{"rendered":"Retrieve Organizations"},"content":{"rendered":"

Organization Details<\/h3>\n

This route will return all Organizations associated with the authenticated user login. Each organization detail contains the resource URI to users, addresses and organization_roles associated with that organization.<\/p>\n

The response contains the following components for each organization:<\/p>\n

– organization_uuid: Unique identifier of the specified organization
\n– orgnization_name: Name of the specified Organization
\n– organization_description: Description of the specified Organization
\n– parent_organization: In case the organizations are nested this will identify the parent of specified Organization.
\n– users: Path to the users of specifed Organization
\n– addresses: Path to the addresses associated to specified Organization
\n– job_code_prefix: Jobs associated with this organization will have a job number starting with this job_code_prefix. <\/p>\n

Resource URI<\/h3>\n
GET \/organizations<\/pre>\n
Sample Request<\/h3>\n
html<\/p>\n
\r\nhttps:\/\/api.4over.com\/organizations\r\n<\/pre>\n
Sample Response<\/h3>\n
\r\nJSON\r\n{\r\nentities: [\r\n  {\r\n        organization_uuid: "5f985c6b-36b5-4fb4-daae-d4e8dcdef61e",\r\n        organization_name: "Test Printers",\r\n        organization_description: "Test Printers",\r\n        parent_organization: {\r\n          organization_uuid: "d6d4e03e-7e88-4f69-9664-2e16da4da2b1",\r\n          organization_name: "API",\r\n          organization_description: "API Subscriber Organizations",\r\n        parent_organization: {\r\n          organization_uuid: "8a17ef16-d997-4544-9f7c-d313febf9c40",\r\n          organization_name: "4over, Inc.",\r\n          organization_description: "4over corporate",\r\n          users: "http:\/\/api.4over.com\/organizations\/8a17ef16-d997-4544-9f7c-d313febf9c40\/users",\r\n          job_code_prefix: "Z"\r\n      },\r\n      users: "http:\/\/api.4over.com\/organizations\/d6d4e03e-7e88-4f69-9664-2e16da4da2b1\/users",\r\n      job_code_prefix: ""\r\n      },\r\n      users: "http:\/\/api.4over.com\/organizations\/5f985c6b-36b5-4fb4-daae-d4e8dcdef61e\/users",\r\n      job_code_prefix: "Z"\r\n    }\r\n  ],\r\n  currentPage: 0,\r\n  maximumPages: 20\r\n}\r\n<\/pre>\n
To get a specific Organization data:<\/h2>\n
Resource URI<\/h3>\n
GET \/organizations\/{organization_uuid}<\/pre>\n
Input Parameters<\/h3>\n
\r\n@param organization_uuid {uuid} The uuid of an Organization.\r\n<\/pre>\n
Sample Request<\/h3>\n
html<\/p>\n
\r\nhttps:\/\/api.4over.com\/organizations\/45514e13-b131-4c1d-b4eb-b40fbf8a3e69\r\n<\/pre>\n
Sample Response<\/h3>\n
\r\nJSON\r\n{\r\n  {\r\n    organization_uuid: "5f985c6b-36b5-4fb4-daae-d4e8dcdef61e",\r\n    organization_name: "Test Printers",\r\n    organization_description: "My Printer",\r\n    parent_organization: {\r\n      organization_uuid: "d6d4e03e-7e88-4f69-9664-2e16da4da2b1",\r\n      organization_name: "API",\r\n      organization_description: "API Subscriber Organizations",\r\n      parent_organization: {\r\n        organization_uuid: "8a17ef16-d997-4544-9f7c-d313febf9c40",\r\n        organization_name: "4over, Inc.",\r\n        organization_description: "4over corporate",\r\n        users: "http:\/\/api.4over.com\/organizations\/8a17ef16-d997-4544-9f7c-d313febf9c40\/users",\r\n        job_code_prefix: "Z"\r\n        },\r\n        users: "http:\/\/api.4over.com\/organizations\/d6d4e03e-7e88-4f69-9664-2e16da4da2b1\/users",\r\n        job_code_prefix: ""\r\n      },\r\n      users: "http:\/\/api.4over.com\/organizations\/5f985c6b-36b5-4fb4-daae-d4e8dcdef61e\/users",\r\n      job_code_prefix: "Z"\r\n    }\r\n}\r\n\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Organization Details This route will return all Organizations associated with the authenticated user login. Each organization detail contains the resource URI to users, addresses and organization_roles associated with that organization. The response contains the following components for each organization: – organization_uuid: Unique identifier of the specified organization – orgnization_name: Name of the specified Organization – […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":47,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-50","page","type-page","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/50","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=50"}],"version-history":[{"count":5,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/50\/revisions"}],"predecessor-version":[{"id":502,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/50\/revisions\/502"}],"up":[{"embeddable":true,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/47"}],"wp:attachment":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=50"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}