Tedee API documentation

Overview

  • Getting started
  • API versioning
  • API rate limit
  • Logo guideliness
  • Release notes

How to ...

  • Begin integration
  • Authenticate
  • Get and sync locks
  • Operate locks
  • Update lock settings
  • Share device
  • Manage lock PIN list
  • Manage access links
  • Manage and operate gates
  • Use state from door sensor
  • Connect to device via Bluetooth
  • Example integrations

Endpoints

  • DateTime
  • Device
  • Device activity
  • Devices certificate
  • Device access
  • Door sensor
  • Gate
  • Lock
  • Lock PIN
  • Mobile
  • Organization
  • Organization Access Links
    • Get organization links
    • Get organization link
    • Get organization link url
    • Get access link assignable devices
      • Responses
      • Scopes
      • Examples
    • Create organization link
    • Update organization link
    • Delete organization link
  • Personal access key

Webhooks

  • Overview
  • Device battery level changed
  • Device connection changed
  • Device settings changed
  • Lock status changed
  • Bell button pressed

Data structures

  • Access details
  • Bridge
  • Certificate for mobile
  • Device activities
  • Device access
  • Device operation
  • Device settings
  • Device access success
  • Device updated
  • Door sensor list
  • Door sensor state
  • Door sensor user settings
  • Door sensor
  • Execute command response
  • Gate list
  • Gate user settings
  • Gate
  • Location
  • Lock
  • Lock accessory
  • Lock PIN
  • Lock PIN created
  • Lock PIN details
  • Lock PIN list
  • Lock state
  • Lock sync
  • Lock user settings
  • Mobile identifier
  • Mobile registered
  • Organization
  • Organization access link
  • Organization access link created
  • Organization access link list
  • Organization access link single
  • Organization access link device
  • Organization access link assignable device list
  • Organization access link assignable device
  • Personal access key
  • Personal access key created
  • Repeat event
  • Revoked certificate
  • Revoked certificate list
  • Signed time
  • Software versions

Enums

  • Access level
  • Activity source
  • Auto unlock pull condition
  • Device operation type
  • Device type
  • Door state
  • Event type
  • Gate icon
  • Lock state
  • Operating System type
  • Software type
  • Unlock mode
  • Week days
Tedee API documentation
  • Organization Access Links
  • Get access link assignable devices
  • View page source

Get access link assignable devices

Get devices which can be assigned to an organization access link.

GET https://api.tedee.com/api/v1.36/organization/{organizationId}/accesslink/device/assignable

URI Parameters

Name

Type

Description

organizationId

number

id of the organization

page

number

page number

itemsPerPage

number (optional)

number of elements to load (max 100, default 100)

filters.DeviceName

string (optional)

filtering device name

filters.DeviceId

int (optional)

filtering by device id

Responses

Name

Type

Description

200 OK

Access Link Assignable Devices List

successful operation

Scopes

Name

Description

AccessLink.Read

Grants user possibility to view organization access links.

AccessLink.ReadWrite

Grants user possibility to manage organization access links.

Examples

Sample request for organization with id = 123

curl -X GET "https://api.tedee.com/api/v1.36/organization/123/accesslink/device/assignable" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Sample response

HTTP status code: 200

{
    "result": {
        "accessLinkDevices": [
            {
                "deviceId": 1,
                "name": "Lock",
                "type": 2,
                "timeZone": "Europe/Warsaw",
                "softwareVersions": [
                {
                    "softwareType": 0,
                    "version": "2.4.5200"
                }
                ]
            },
            {
                "deviceId": 2,
                "name": "Gate",
                "type": 5,
                "timeZone": "Europe/London",
                "softwareVersions": [
                {
                    "softwareType": 0,
                    "version": "2.4.2081"
                }
                ]
            }
        ],
        "page": 1,
        "itemsPerPage": 25
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 200
}
Previous Next

© Copyright 2023, Tedee.

Built with Sphinx using a theme provided by Read the Docs.