Get Brands

KLINICLY is an Open Source API that's enables innovators and health-tech businesses to easily embed and distribute genuine drugs using our formulary within their products.

HTTP REQUEST

Get Brands

get

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Query parameters

SearchQuerystringOptional

PageNumberinteger · int32Optional

PageSizeinteger · int32Optional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Brand

HTTPcURLJavaScriptPython

GET /api/v1/Brand HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "dosage": "text",
      "email": "text",
      "phoneNumber": "text",
      "imageFileName": "text",
      "imageFileBinary": "text",
      "imageFileExt": "text",
      "company": "text",
      "generic": "text",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "genericId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com"
}

Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

Get Brand by ID

Get Brand by Id

get

e.g GET /api/v1/Brand/7fff8c61-26c4-4907-b659-3f823f3b3be4

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Path parameters

Idstring · uuidRequired

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Brand/{Id}

HTTPcURLJavaScriptPython

GET /api/v1/Brand/{Id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "dosage": "text",
    "email": "text",
    "phoneNumber": "text",
    "imageFileName": "text",
    "imageFileBinary": "text",
    "imageFileExt": "text",
    "company": "text",
    "generic": "text",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "genericId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Good to know: This API method was auto-generated from an example Swagger file. You'll see that it's not editable – that's because the contents are synced to an URL! Any time the linked file changes, the documentation will change too.

Get Brand by Lite

Get All Brands For DropDown

get

e.g GET /api/v1/brand/dropdown

Authorizations

Bearer

AuthorizationstringRequired

Input your Bearer token in this format - Bearer {your token here} to access this WebApi

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

500

Server Error

text/plainapplication/jsontext/json

get

/api/v1/Brand/lite

HTTPcURLJavaScriptPython

GET /api/v1/Brand/lite HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "succeeded": true,
  "message": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ]
}