Jump to Content
Logitech CircleLogitech Developer HubCircleAPI ReferenceTerminologyBlog
HomeTerminologyAPI ReferenceBlog
Logitech Developer HubCircleAPI ReferenceTerminologyBlogLogitech Circle

Components

  • Activity Filter Syntax
  • Classifiers
    • Activity Set
    • Object Color
    • Object Location
    • Object Size
    • Object Type
    • Relevance Level
  • Service Plan Features
    • Advanced Timeline Filters Feature
    • Color Detection Feature
    • Custom Day Brief Feature
    • Object Locations Feature
    • Object Type Detection Feature
    • Size Detection Feature
    • Storage Length Feature
    • Zones Feature
  • WEBVTT
  • Zone

Permissions

  • Permissions
  • circle:accessories
  • circle:accessories_ro
  • circle:accessories_manage
  • circle:activities
  • circle:activities_basic
  • circle:live
  • circle:live_image
  • circle:notifications
  • circle:notifications_motion
  • circle:summaries

Common HTTP Responses

  • 200 - Ok
  • 201 - Created
  • 204 - No Content
  • 400 - Bad Request
  • 401 - Unauthorized
  • 402 - Payment Required
  • 403 - Forbidden
  • 404 - Not Found
  • 408 - Request Timeout
  • 409 - Conflict
  • 410 - Gone
  • 429 - Too Many Requests
  • 503 - Service Unavailable

Permissions

Suggest Edits

The Logitech Circle API uses a permissions scope system. When used with OAuth2 Authentication, the scopes must be passed as the OAuth2 scope being requested.

Some permissions are inclusive and can be combined. Some permissions supercede others. For example, you don't need to ask for circle:activities_basic if you are requesting circle:activities.

Permission errors typically manifest as 403 - Forbidden responses.

The following permission scopes are defined.
circle:accessories
circle:accessories_ro
circle:accessories_manage
circle:activities
circle:activities_basic
circle:live
circle:live_image
circle:notifications
circle:summaries

Updated almost 4 years ago