Get Organization Info

Get Organization Info

GET https://{server_address}/api/v1/organization

Get organization information by it's identifier.

Query Parameters

Name	Type	Description
orgId*	1	Organization identifier

Headers

Name	Type	Description
Authorization*	Bearer {access_token}

200: OK Organization info

{
   "id": 658,
   "name": "My Awesome Organization",
   "description": "Some description",
   "parentOrganizationId": 657,
   "isActive": true,
   "tz": "Europe/Kiev",
   "unitSystem": "IMPERIAL",
   "phoneNumber": "[phone]"
   "address": {
      "fullAddress": "Khreshchatyk st.",
      "city": "Kyiv",
      "country": "Ukraine",
      "state": "Ukraine",
      "zip": "02000"
   },
   "lastModifiedTs": 1694707051504
}

404: Not Found Organization is not found

{
    "error": {
        "message": "Organization is not found or you don't have access to it."
    }
}

Request examples:

# curl command example:
$ curl -H "Authorization: Bearer {accessToken}" https://fra1.blynk.cloud/api/v1/organization?orgId=1
$ curl -H "Authorization: Bearer eIdWHQqRfFmvP5LDDh-IGxPUzi7I27HthzCPAVmS" https://fra1.blynk.cloud/api/organization?orgId=1

# httpie command exmaple:
$ https -A bearer -a {accessToken} fra1.blynk.cloud/api/organization?orgId=1
$ https -A bearer -a eIdWHQqRfFmvP5LDDh-IGxPUzi7I27HthzCPAVmS fra1.blynk.cloud/api/v1/organization?orgId=1