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: Deskcrew Io Devices API
version: 1.0.0
contact:
name: DeskCrew support
url: https://deskcrew.io/board/deskcrew
email: hello@deskcrew.io
description: 'Operations tagged Devices across 2 of this provider''s published API definitions: openapi.json, deskcrew-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://deskcrew.io
security:
- bearerAuth: []
tags:
- name: Devices
paths:
/api/v1/devices/me:
patch:
summary: Update this device (push token, name, version)
description: The device is always the one whose session made the request. Needs the tickets:write scope. Requires the `tickets:write` scope.
operationId: patch_api_v1_devices_me
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 'pushToken: string | null; pushEnv: sandbox | production; name: string; appVersion: string'
responses:
'200':
description: Success
'401':
description: Missing or invalid API key
'403':
description: The key does not hold the required scope
'404':
description: Not found in this workspace
'429':
description: Rate limited
tags:
- Devices
delete:
summary: Sign this device out
description: Revokes the session behind the token; it is refused from the next request. Needs the tickets:write scope. Requires the `tickets:write` scope.
operationId: delete_api_v1_devices_me
security:
- bearerAuth: []
responses:
'200':
description: Success
'401':
description: Missing or invalid API key
'403':
description: The key does not hold the required scope
'404':
description: Not found in this workspace
'429':
description: Rate limited
tags:
- Devices
servers:
- url: https://deskcrew.io
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: A workspace API key that starts with dk_, or a signed-in person's session token from the DeskCrew apps.
x-refined-from:
- openapi.json
- deskcrew-io-openapi.json
x-scopes:
- tickets:read
- tickets:write
- tickets:reply
- issues:read
- issues:write
- changelog:read
- changelog:write
- customers:read
- kb:read
- kb:write
- webhooks:manage
- errors:write
- bounties:manage
- bounties:read