Get Keys

Returns Keys for Locks that are part of this Project. Use query parameters to filter the results to a specific App User, Lock or Key state.

  • Use the appUserId parameter to limit results to Keys for a specific App User.
  • Use the lockId parameter to limit results to Keys for a specific Lock.
  • Use the excludeStates parameter to exclude Keys in a specific state. For example, to exclude revoked Keys, use excludeStates=revoked.
  • Use excludeSubprojectKeys to exclude Subproject Keys from the results.

Use the limit parameter to specify how many items you want to receive. If not specified, limit is set to the maximum supported value of the API: 2500. You can use the limit and startAfterId query parameters together in order to implement a pagination system.

Required Scopeproject.admin
Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!