openapi: 3.0.0
info:
title: Labguru Antibodies Units API
description: "Labguru API is a JSON / REST based API, get started by reviewing the documentation below or code samples.<br>\n Join our dedicated [Slack channel](https://join.slack.com/t/labgurus/shared_invite/zt-199glfagl-QZQ_bKl7vLAi8CQSuNrRug)\n to be in direct contact with our API team and be informed about the latest updates.<br>\n ***[API introduction and overview](https://help.labguru.com/en/articles/6149483-api-introduction-and-overview)***"
version: v1
tags:
- name: Units
paths:
/api/v1/units:
post:
summary: Add unit
tags:
- Units
parameters: []
responses:
'201':
description: unit created
'422':
description: invalid request - Name can't be blank
'401':
description: 'Error: Unauthorized'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createUnit'
required: true
get:
summary: List all units in your account
tags:
- Units
parameters:
- name: token
in: query
required: true
schema:
type: string
- name: page
in: query
description: the default call is with page = 1
schema:
type: integer
- name: meta
in: query
description: ' show summarized data information - true/false'
schema:
type: string
responses:
'200':
description: success
'404':
description: page not found
/api/v1/units/{id}:
delete:
summary: Delete unit
tags:
- Units
parameters:
- name: id
in: path
required: true
description: unit id
schema:
type: integer
responses:
'204':
description: unit deleted
'422':
description: invalid request
'401':
description: 'Error: Unauthorized'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/deleteUnit'
required: true
get:
summary: Get unit by id
tags:
- Units
parameters:
- name: token
in: query
required: true
schema:
type: string
- name: id
in: path
required: true
description: unit id
schema:
type: integer
responses:
'200':
description: success
'404':
description: page not found
components:
schemas:
deleteUnit:
type: object
required:
- token
- unit_type
properties:
token:
type: string
example: YOUR TOKEN IS HERE
unit_type:
type: string
description: weight/volume/concentration
example: weight
createUnit:
type: object
required:
- token
properties:
token:
type: string
example: YOUR TOKEN IS HERE
item:
type: object
required:
- name
- type_for
properties:
name:
type: string
description: 'unit name '
type_for:
type: string
description: weight/volume/concentration