TANSS icon

TANSS

Interact with the TANSS API

Actions208

Periphery → List Peripheries

AI-generated

Summary

Retrieve a list of periphery devices filtered by company, branch settings, activity state, and periphery type from the TANSS system using selected authentication mode.

Inputs

  • Auth Mode — Select TANSS credential type for authentication: Generated Token or User Login (Auto Refresh). Defaults to User Login.
  • Company ID — Numeric ID to filter peripheries belonging only to this company.
  • Branches — Filter by branch visibility: COMPANY_ONLY, BRANCHES_ONLY, COMPANY_AND_BRANCHES, or SPECIFIC_BRANCH.
  • Active — Filter by active state: ACTIVE_ONLY, INACTIVE_ONLY, or ACTIVE_AND_INACTIVE.
  • Periphery Type ID — Numeric ID to filter peripheries by their type.

Output shape

a JSON list of periphery objects matching the applied filters

The response includes periphery details filtered according to the given parameters. Filters are optional; if omitted, broadest matching set is returned under selected auth mode.

Links

Discussion