Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Labguru Events API
description: 'Labguru API is a JSON / REST based API, get started by reviewing the documentation below or code samples.
Join our dedicated Slack channel
to be in direct contact with our API team and be informed about the latest updates.
***API introduction and overview***'
version: v1
tags:
- name: Events
paths:
/api/v1/events:
post:
summary: Add an event
tags:
- Events
parameters: []
responses:
'201':
description: event created
'422':
description: Repeats frame should be a number and greater than 0
'401':
description: 'Error: Unauthorized'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createEvent'
required: true
operationId: postApiV1Events
x-operation-id-source: derived
get:
summary: List all event in your account
tags:
- Events
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
operationId: getApiV1Events
x-operation-id-source: derived
/api/v1/events/{id}:
put:
summary: Update event attributes
tags:
- Events
parameters:
- name: id
in: path
required: true
description: event id
schema:
type: integer
responses:
'200':
description: event updated
'422':
description: invalid request
'401':
description: 'Error: Unauthorized'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updateEvent'
required: true
operationId: putApiV1EventsById
x-operation-id-source: derived
get:
summary: Get event by id
tags:
- Events
parameters:
- name: token
in: query
required: true
schema:
type: string
- name: id
in: path
required: true
description: event id
schema:
type: integer
responses:
'200':
description: success
'404':
description: event not found
operationId: getApiV1EventsById
x-operation-id-source: derived
delete:
summary: Delete event
tags:
- Events
parameters:
- name: token
in: query
required: true
schema:
type: string
- name: id
in: path
required: true
description: event id
schema:
type: integer
responses:
'204':
description: no content
'404':
description: page not found
operationId: deleteApiV1EventsById
x-operation-id-source: derived
components:
schemas:
updateEvent:
allOf:
- $ref: '#/components/schemas/EventBaseRequest'
createEvent:
allOf:
- $ref: '#/components/schemas/EventBaseRequest'
- type: object
properties:
item:
type: object
required:
- name
- start_date
- end_date
EventBaseRequest:
type: object
required:
- token
properties:
token:
type: string
example: YOUR TOKEN IS HERE
item:
type: object
properties:
name:
type: string
description: event title
start_date:
type: string
format: date
description: the event start date
end_date:
type: string
format: date
description: the event end date
description:
type: string
description: ' text description for this event'
notify_members:
type: string
description: 'who should be notified regarding the event: notify only me =[1], notify all participants = [-1], none =[0]'
example: '[0]'
notify_at:
type: string
format: date
description: when to notify about the event
is_fullday_event:
type: boolean
description: true/false
repeats:
type: integer
description: 1/0
repeat_frame:
type: string
description: the time frame which the event will be repeated at - Never, days, weeks, months
example: Never
eventable_id:
type: integer
description: the equipment id which the event is related to
eventable_type:
type: string
description: the item class name - System::Instrument
example: System::Instrument
x-provenance:
method: harvested
publisher: Cenevo
source: https://my.labguru.com/api-docs/v1/swagger.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)