KISI Group locks API
The Group locks API from KISI — 2 operation(s) for group locks.
The Group locks API from KISI — 2 operation(s) for group locks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/kisi:kisi-group-locks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
title: Kisi Group locks API
description: '## Introduction
Welcome to the Kisi API documentation.'
contact:
name: Kisi Support
email: support@getkisi.com
servers:
- url: https://api.kisi.io
description: Kisi Production
tags:
- name: Group locks
paths:
/group_locks:
get:
operationId: fetchGroupLocks
summary: Fetch group locks
tags:
- Group locks
security:
- Kisi-Login: []
- OAuth2: []
parameters:
- name: group_id
in: query
schema:
type: integer
required: true
description: The ID of the group to scope by
- name: ids
in: query
schema:
type: string
description: Filter by object IDs
- name: lock_id
in: query
schema:
type: integer
description: Filter by lock ID
- name: query
in: query
schema:
type: string
description: 'Filter by a freetext string. Properties searched: `name`
'
- name: limit
in: query
schema:
type: integer
default: 10
maximum: 250
description: The number of objects to return
- name: offset
in: query
schema:
type: integer
default: 0
maximum: 20000
description: The number of objects to offset
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
title: Group Lock
properties:
id:
type: integer
description: The ID of the group lock
resource_type:
type: string
description: The resource type of the group lock
const: GroupLock
created_at:
type: string
format: date-time
description: When the group lock was created
updated_at:
type: string
format: date-time
description: When the group lock was updated
group_id:
type: integer
description: The group ID of the group lock
group:
type: object
title: Group
description: The group of the group lock
properties:
id:
type: integer
description: The ID of the group
resource_type:
type: string
description: The resource type of the group
const: Group
name:
type: string
description: The name of the group
required:
- id
- resource_type
- name
additionalProperties: false
lock_id:
type: integer
description: The lock ID of the group lock
lock:
type: object
title: Lock
description: The lock of the group lock
properties:
id:
type: integer
description: The ID of the lock
description:
type:
- string
- 'null'
description: The description of the lock
name:
type: string
description: The name of the lock
required:
- id
- description
- name
additionalProperties: false
place_id:
type: integer
description: The place ID of the group lock
place:
type: object
title: Place
description: The place of the group lock
properties:
id:
type: integer
description: The ID of the place
resource_type:
type: string
description: The resource type of the place
const: Place
name:
type: string
description: The name of the place
required:
- id
- resource_type
- name
additionalProperties: false
required:
- id
- resource_type
- created_at
- updated_at
- group_id
- group
- lock_id
- lock
- place_id
- place
additionalProperties: false
headers:
X-Collection-Range:
description: 'Pagination information for offset based pagination. `start-end` represents the range
of items requested. `total` represents the total count of items. If there is a total
of 15 items and an offset of 10 and limit of 10 is used, the resulting header is:
`10-19/15`.
'
schema:
type: string
pattern: ^(?<start>\d+)-(?<end>\d+)/(?<total>\d+)$
example: 0-9/200
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: createGroupLock
summary: Create group lock
tags:
- Group locks
security:
- Kisi-Login: []
- OAuth2: []
requestBody:
content:
application/json:
schema:
type: object
title: Group Lock
properties:
group_lock:
type: object
properties:
group_id:
type: integer
description: The group ID of the group lock
lock_id:
type: integer
description: The lock ID of the group lock
required:
- group_id
- lock_id
required:
- group_lock
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Group Lock
properties:
id:
type: integer
description: The ID of the group lock
resource_type:
type: string
description: The resource type of the group lock
const: GroupLock
created_at:
type: string
format: date-time
description: When the group lock was created
updated_at:
type: string
format: date-time
description: When the group lock was updated
group_id:
type: integer
description: The group ID of the group lock
group:
type: object
title: Group
description: The group of the group lock
properties:
id:
type: integer
description: The ID of the group
resource_type:
type: string
description: The resource type of the group
const: Group
name:
type: string
description: The name of the group
required:
- id
- resource_type
- name
additionalProperties: false
lock_id:
type: integer
description: The lock ID of the group lock
lock:
type: object
title: Lock
description: The lock of the group lock
properties:
id:
type: integer
description: The ID of the lock
description:
type:
- string
- 'null'
description: The description of the lock
name:
type: string
description: The name of the lock
required:
- id
- description
- name
additionalProperties: false
place_id:
type: integer
description: The place ID of the group lock
place:
type: object
title: Place
description: The place of the group lock
properties:
id:
type: integer
description: The ID of the place
resource_type:
type: string
description: The resource type of the place
const: Place
name:
type: string
description: The name of the place
required:
- id
- resource_type
- name
additionalProperties: false
required:
- id
- resource_type
- created_at
- updated_at
- group_id
- group
- lock_id
- lock
- place_id
- place
additionalProperties: false
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
/group_locks/{id}:
get:
operationId: fetchGroupLock
summary: Fetch group lock
tags:
- Group locks
security:
- Kisi-Login: []
- OAuth2: []
parameters:
- name: id
in: path
schema:
type: integer
required: true
description: The ID of the object
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Group Lock
properties:
id:
type: integer
description: The ID of the group lock
resource_type:
type: string
description: The resource type of the group lock
const: GroupLock
created_at:
type: string
format: date-time
description: When the group lock was created
updated_at:
type: string
format: date-time
description: When the group lock was updated
group_id:
type: integer
description: The group ID of the group lock
group:
type: object
title: Group
description: The group of the group lock
properties:
id:
type: integer
description: The ID of the group
resource_type:
type: string
description: The resource type of the group
const: Group
name:
type: string
description: The name of the group
required:
- id
- resource_type
- name
additionalProperties: false
lock_id:
type: integer
description: The lock ID of the group lock
lock:
type: object
title: Lock
description: The lock of the group lock
properties:
id:
type: integer
description: The ID of the lock
description:
type:
- string
- 'null'
description: The description of the lock
name:
type: string
description: The name of the lock
required:
- id
- description
- name
additionalProperties: false
place_id:
type: integer
description: The place ID of the group lock
place:
type: object
title: Place
description: The place of the group lock
properties:
id:
type: integer
description: The ID of the place
resource_type:
type: string
description: The resource type of the place
const: Place
name:
type: string
description: The name of the place
required:
- id
- resource_type
- name
additionalProperties: false
required:
- id
- resource_type
- created_at
- updated_at
- group_id
- group
- lock_id
- lock
- place_id
- place
additionalProperties: false
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteGroupLock
summary: Delete group lock
tags:
- Group locks
security:
- Kisi-Login: []
- OAuth2: []
parameters:
- name: id
in: path
schema:
type: integer
required: true
description: The ID of the object
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Errors:
description: Schema describing validation errors.
type: object
properties:
errors:
type: object
additionalProperties:
type: array
items:
type: string
example:
email:
- can't be blank or invalid
password:
- can't be blank
required:
- errors
Error:
description: Schema describing errors.
type: object
properties:
error:
type: string
description: The error message.
example: Wrong email address or password.
code:
type: string
description: An identifier of the error.
example: afc516
required:
- error
- code
securitySchemes:
Webhook-Signature:
type: apiKey
in: header
name: X-Signature
description: 'Authorize using a signature of the request body. The signature is a HMAC-SHA256 hash of the request body using a secret key. <br><br>E.g. `X-Signature: 123`'
Kisi-Login:
type: apiKey
in: header
name: Authorization
description: 'Authorize using a login. Prefix the value with `KISI-LOGIN`<br><br>Example: `Authorization: KISI-LOGIN 123`'
Kisi-Access-Key:
type: apiKey
in: header
name: Authorization
description: 'Authorize using an access key. Prefix the value with `KISI-ACCESS-KEY`<br><br>Example: `Authorization: KISI-ACCESS-KEY 123`'
Kisi-Group-Link:
type: apiKey
in: header
name: Authorization
description: 'Authorize using a group link. Prefix the value with `KISI-GROUP-LINK`<br><br>Example: `Authorization: KISI-GROUP-LINK 123`'
Kisi-Service:
type: apiKey
in: header
name: Authorization
description: 'Authorize using a service. Prefix the value with `KISI-SERVICE`<br><br>Example: `Authorization: KISI-SERVICE 123`'
OAuth2Basic:
type: http
scheme: basic
description: Username is the client id. Password is the client secret.
OAuth2:
type: oauth2
description: 'OAuth access tokens are sent as bearer tokens. Example: `Authorization: Bearer youraccesstoken`'
flows:
authorizationCode:
authorizationUrl: https://api.kisi.io/oauth/authorize
tokenUrl: https://api.kisi.io/oauth/token
scopes: {}
x-provenance:
method: harvested
publisher: KISI
source: https://api.getkisi.com/openapi/apps.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)