Retrieve Institution by Custom field

Overview

You can retrieve information for set institution preferences for a specific institution by using the GET method, as described below.

Resource Access

GET https://<hostname>/institution/v1/institution/export?fields=fieldname&fields=fieldname

Parameters

The requested criteria can be a combination of one or more of the following fields:

Keys	Values
filter	%7B%7D
field	<field user wants to search>
size	10
sort	created%3Adesc

Example Request

🚧
GET https://<hostname>/institution/v1/institution/export?fields=name&fields=fid&fields=externalStatus&fields=status&fields=activeBuyers&fields=totalBuyers&fields=created&fields=id&filter=%7B%7D&from=0&networkId=0&page=1&search=&size=10&sort=created%3Adesc
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json

Example Response


{
   "_scroll_id": "eyJhbGciOiJFUzI1NiJ9.eyJzY3JvbGxJZCI6IkZHbHVZMngxWkdWZlkyOXVkR1Y0ZEY5MWRXbGtEWEYxWlhKNVFXNWtSbVYwWTJnQkZuZHZWbUZsYlZWelVXbGxORU5IY0VsV1pHVmhlR2NBQUFBQUFDUV9xUlkyY2w5eFdsbEZRMU0yTFdReWREWlhiMEZsTWxWMyIsInRlbmFudElkIjoiNUQ0Q0QxRUEtNzI0Qi00NkFDLUE4NzgtMEIwNjhFMjM5RTAyIiwidmlydHVhbEVudiI6ImF3cy1udi1jcHhxYSIsInVzZXJJZCI6ImUyNGJkYTg4LWQ5ZWQtNTczMC1hMzExLTA1NDg4YjdkNjVlZCJ9.2o-1Xp2uHXaemDFVGawZnfFOYzR2OHKBAmWiZECeNdNPqRXUmXZfQfXVfniQ8b6IYCDMjQRUUtYztDGonLxljQ",
   "totalRecords": 9921,
   "totalType": "exact",
   "recordCount": 10,
   "records": [
       {
           "fid": "API1234Testin",
           "created": "2023-12-18T06:25:30.070Z",
           "name": "API Institution",
           "id": "4064e191-f000-548d-82f4-5c835aad1bbe",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "8237923gdi",
           "created": "2023-12-18T05:43:15.090Z",
           "name": "john",
           "id": "7c19e1f0-580b-5a4f-ab89-02b76906a70b",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute3783",
           "created": "2023-12-15T11:33:40.573Z",
           "name": "A API Institution",
           "id": "11375656-a729-55bf-ae5e-393d69b0a3df",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute9012",
           "created": "2023-12-15T10:34:49.665Z",
           "name": "Ab API Institution2",
           "id": "e7e0c1ac-225c-5855-939c-58ec6b12b8a6",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute9011",
           "created": "2023-12-15T10:14:33.444Z",
           "name": "Ab API Institution1",
           "id": "2afcc558-40ed-5bbc-be2a-8dc1e4cd28fc",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute902",
           "created": "2023-12-15T10:13:26.817Z",
           "name": "Ab API Institution",
           "id": "d4ed2aad-6f38-5e6e-ac29-e692115cda1a",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute901",
           "created": "2023-12-15T10:13:18.796Z",
           "name": "Ab API Institution",
           "id": "2b4968bc-e528-55fc-b0a7-10066a3aa760",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "HBWBCDBE",
           "created": "2023-12-15T10:04:37.949Z",
           "name": "tEST",
           "id": "c0fb32bf-f683-532c-95dd-cd457269002d",
           "externalStatus": "Active",
           "status": "Received",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute90",
           "created": "2023-12-15T09:59:58.253Z",
           "name": "Test minimum API Institution",
           "id": "d781e524-ffc9-5e1a-aa27-7dffcaa1b504",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       },
       {
           "fid": "APIinstitute1",
           "created": "2023-12-15T09:01:58.721Z",
           "name": "Test API Institution Updated",
           "id": "04a29a09-6d54-5074-9346-1dc7cdf71357",
           "externalStatus": "Active",
           "status": "Approved",
           "totalBuyers": 0,
           "activeBuyers": 0
       }
   ]
}

👍
HTTP Status: 200 OK
Content-Type → application/json