• Venue and event management in the cloud

How Can We Help?


Organisations: Search Organisation By Id

In this article


Search Organisation By Id

POST /v2/organisation/getById

This API returns the complete organisation details for specified Organisation Id. Multiple organisation's  details can also be found by specifying Id in multiple JSON Objects as shown below:


Parameter
Id    String

Array of organisation id of the organisations to be retrieved.

[
   {
      "Id" : 100147024
   },
   {
      "Id" : 100147027
   }
]
Response:

Returns the organisation details for the specified organisation Ids.

{
   "success": true,
   "result": [
      {
         "TaxNo": "",
         "OtherPhone": "",
         "Email": "acmeorg@gmail.com",
         "Address": [
            {
               "AddressLine3": "BUSINESS Address 3",
               "AddressLine2": "BUSINESS Address 2",
               "AddressLine1": "BUSINESS Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            },
            {
               "AddressLine3": "POSTAL Address 3",
               "AddressLine2": "POSTAL Address 2",
               "AddressLine1": "POSTAL Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            },
            {
               "AddressLine3": "OTHER Address 3",
               "AddressLine2": "OTHER Address 2",
               "AddressLine1": "OTHER Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            }
         ],
         "Parent": "ParentOrg",
         "PrimaryPhone": "B",
         "OrganisationId": 100147024,
         "Website": "www.test.com",
         "MarketSector": "Information Technology",
         "Name": "Org1 Name",
         "DebtorNumber": "123a",
         "ExternalRefNo": "",
         "Type": "Corporate",
         "CustomFields": {
            "RegistrationNumber": "ABC9999"
         },
         "Inactive": false,
         "BusinessPhone": "5555666",
         "Fax": "",
         "EmailOther": "acmeorgot@hege.afds"
      },
      {
         "TaxNo": "",
         "OtherPhone": "",
         "Email": "acmeorg@gmail.com",
         "Address": [
            {
               "AddressLine3": "BUSINESS Address 3",
               "AddressLine2": "BUSINESS Address 2",
               "AddressLine1": "BUSINESS Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            },
            {
               "AddressLine3": "POSTAL Address 3",
               "AddressLine2": "POSTAL Address 2",
               "AddressLine1": "POSTAL Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            },
            {
               "AddressLine3": "OTHER Address 3",
               "AddressLine2": "OTHER Address 2",
               "AddressLine1": "OTHER Address 1",
               "Suburb": "Australian Capital",
               "State": "Queensland",
               "isPrimary": false,
               "Country": "Australia",
               "Postcode": "112098"
            }
         ],
         "Parent": "ParentOrg",
         "PrimaryPhone": "B",
         "OrganisationId": 100147027,
         "Website": "www.test.com",
         "MarketSector": "Information Technology",
         "Name": "Org2 Name",
         "DebtorNumber": "123a",
         "ExternalRefNo": "",
         "Type": "Corporate",
         "CustomFields": {
            "RegistrationNumber": "ABC12345",
         },
         "Inactive": false,
         "BusinessPhone": "5555666",
         "Fax": "",
         "EmailOther": "acmeorgot@hege.afds"
      }
   ]
}