Search Organizations

Search Organizations

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

sortBy query parameter could accept the following values: Organization Id, Name, Device Count, User Count, Sub Organizations (stands for sub-organizations count).

Query Parameters

Name	Type	Description
query*	dev org	Search query. Should be up to 255 symbols.
page	0	Page number starting from 0. First page by default.
size	20	Page size. Should be from 1 to 100. 20 by default.
sortBy	Organization Id	Field to sort result by.
sortOrder	ASC	Sorting order. Could be ASC (ascending sort order) or DESC (descending sort order). ASC by default.

Headers

Name	Type	Description
Authorization*	Bearer {access_token}

200: OK Organizations

{
   "content": [
      {
         "id": 751,
         "name": "Test Organization",
         "description": "Test Sub Organization",
         "parentOrganizationId": 750,
         "isActive": false,
         "tz": "Europe/Kiev",
         "unitSystem": "METRIC",
         "phoneNumber": "[phone]",
         "address": {
            "fullAddress": "Khreschatyk, Kyiv, Ukraine",
            "city": "Kyiv",
            "country": "Ukraine",
            "state": "Kyiv",
            "zip": "02002"
         },
         "lastModifiedTs": 1703068747351
      }
   ],
   "totalElements": 1
}

Request examples:

# curl command example:
$ curl -H "Authorization: Bearer {accessToken}" https://fra1.blynk.cloud/api/v1/organization/search?query=dev+org
$ curl -H "Authorization: Bearer eIdWHQqRfFmvP5LDDh-IGxPUzi7I27HthzCPAVmS" https://fra1.blynk.cloud/api/v1/organization/search?query=dev+org