Organisation APIs

Get Organisation

OVERVIEW

Overview

Get an organisation from Publisher

This API call is used to retrieve an organisation from the system. The organisation identifier is the organisation id.

Since v4.6

HTTP Request

GET  /api/2/organisations/<ID>

 

URL Parameters
Parameter Description
ID The ID of the organisation to retrieve

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
     

 

 

HTTP Response

Success

HTTP response 200 with Organisation object

(Example below)

 

Error

See API Error messages

 

Example HTTP Request & Response

GET http://example.com/context/api/2/organisations/3

 

JSON Response

{

    "organisation": { 

        "id": 3,

        "name": "HighQ",

        "status": "Active",

        "autologin": true,

        "domains": [

            "highq.com"

        ],

        "homepage": 451,

        "guid": 23,

        "url": "http://highq.com",

        "addresses": [

            {

                "addressid": 8,

                "isDefault": true

            }

        ],

        "img": "http://example.com/img.jpg",

        "industry": 359,

        "category": 145,

        "keycontacts": [

            476,

            512,

            987

         ],

         "users": [

            143,

            476,

            512,

            987

        ]

    }

}

 

XML Response

<organisation>

    <id>3</id>

    <name>HighQ</name>

    <status>Active</status>

    <autologin>true</autologin>

    <domains>

        <domain>highq.com</domain>

    </domains>

    <homepage>451</homepage>

    <guid>23</guid>

    <url>http://highq.com</url>

    <addresses>

        <address>

            <addressid>8</addressid>

            <isDefault>true</isDefault>

        </address>

    </address>

    <img></img>

    <industry>359</industry>

    <category>145</category>

    <keycontacts>

        <keycontact>476</keycontact>

        <keycontact>512</keycontact>

        <keycontact>987</keycontact>

    </keycontacts>

    <users>

        <user>143</user>

        <user>476</user>

        <user>512</user>

        <user>987</user>

    </users>       
           
</organisation>

 

 

Comments


0 Comments

Last Updated: Nov 08,2024