SeamOSRouteTypes.Routes.md

seamapi / Exports / SeamOSRouteTypes / Routes

Interface: Routes

SeamOSRouteTypes.Routes

Table of contents

Properties

• /access_codes/create
• /access_codes/delete
• /access_codes/get
• /access_codes/list
• /access_codes/unmanaged/delete
• /access_codes/unmanaged/list
• /access_codes/unmanaged/update
• /access_codes/update
• /access_passes/create
• /access_passes/create_from_access_code
• /access_passes/delete
• /access_passes/get
• /access_passes/get_count_summary
• /access_passes/list
• /access_passes/list_accessible_devices
• /access_passes/update
• /buildings/add_device
• /buildings/add_user
• /buildings/create
• /buildings/delete
• /buildings/get
• /buildings/get_count_summary
• /buildings/list
• /buildings/list_count_summaries
• /buildings/remove_device
• /buildings/remove_user
• /buildings/update
• /buildings/update_user_role
• /device_groups/create
• /device_groups/delete
• /device_groups/get
• /device_groups/list
• /device_groups/update
• /devices/delete
• /devices/get
• /devices/get_count_summary
• /devices/list
• /devices/list_counts
• /devices/update
• /events/get_count_summary
• /events/list
• /health
• /incidents/list
• /linked_accounts/delete
• /linked_accounts/get
• /linked_accounts/get_counts
• /linked_accounts/list
• /locks/lock
• /locks/unlock
• /login_portals/create
• /login_portals/delete
• /login_portals/get
• /login_portals/list
• /organizations/create
• /organizations/get
• /organizations/get_count_summary
• /organizations/invite_user
• /organizations/list
• /organizations/pending_users/delete
• /organizations/pending_users/list
• /organizations/pending_users/resend_invitation
• /organizations/pending_users/update
• /organizations/remove_user
• /organizations/update
• /organizations/update_user_role
• /user_groups/add_user
• /user_groups/create
• /user_groups/delete
• /user_groups/get
• /user_groups/list
• /user_groups/remove_user
• /user_groups/update
• /users/delete
• /users/get
• /users/get_building_roles
• /users/list
• /users/list_my_organizations
• /users/list_organization_roles
• /users/update

Properties

/access_codes/create

• /access_codes/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.code?	string
jsonBody.device_id	string
jsonBody.ends_at?	string | Date
jsonBody.name?	string
jsonBody.starts_at?	string | Date
jsonResponse	Object
jsonResponse.access_code	{ access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: null ; is_managed: boolean ; starts_at: null ; status: "setting" | "set" | "unset" | "removing" ; type: "ongoing" } | { access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: string ; is_managed: boolean ; starts_at: string ; status: "setting" | "set" | "unset" | "removing" ; type: "time_bound" }
method	"POST"
queryParams	Object
route	"/access_codes/create"

Defined in

src/seam-os/routes.ts:2

---

/access_codes/delete

• /access_codes/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_code_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/access_codes/delete"

Defined in

src/seam-os/routes.ts:39

---

/access_codes/get

• /access_codes/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_code_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_code	{ access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: null ; is_managed: boolean ; starts_at: null ; status: "setting" | "set" | "unset" | "removing" ; type: "ongoing" } | { access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: string ; is_managed: boolean ; starts_at: string ; status: "setting" | "set" | "unset" | "removing" ; type: "time_bound" }
method	"POST" | "GET"
queryParams	Object
route	"/access_codes/get"

Defined in

src/seam-os/routes.ts:50

---

/access_codes/list

• /access_codes/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.device_id?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_codes	({ access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: null ; is_managed: boolean ; starts_at: null ; status: "setting" | "set" | "unset" | "removing" ; type: "ongoing" } | { access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: string ; is_managed: boolean ; starts_at: string ; status: "setting" | "set" | "unset" | "removing" ; type: "time_bound" })[]
method	"POST" | "GET"
queryParams	Object
route	"/access_codes/list"

Defined in

src/seam-os/routes.ts:83

---

/access_codes/unmanaged/delete

• /access_codes/unmanaged/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_code_id	string
commonParams.device_id?	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/access_codes/unmanaged/delete"

Defined in

src/seam-os/routes.ts:118

---

/access_codes/unmanaged/list

• /access_codes/unmanaged/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.device_id?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_codes	({ access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: null ; is_managed: boolean ; starts_at: null ; status: "setting" | "set" | "unset" | "removing" ; type: "ongoing" } | { access_code_id: string ; code: null | string ; created_at: string | Date ; ends_at: string ; is_managed: boolean ; starts_at: string ; status: "setting" | "set" | "unset" | "removing" ; type: "time_bound" })[]
method	"GET"
queryParams	Object
queryParams.device_id	string
route	"/access_codes/unmanaged/list"

Defined in

src/seam-os/routes.ts:130

---

/access_codes/unmanaged/update

• /access_codes/unmanaged/update: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_code_id	string
commonParams.is_managed	boolean
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/access_codes/unmanaged/update"

Defined in

src/seam-os/routes.ts:167

---

/access_codes/update

• /access_codes/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.access_code_id	string
jsonBody.code?	string
jsonBody.device_id?	string
jsonBody.ends_at?	string | Date
jsonBody.name?	string
jsonBody.starts_at?	string | Date
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/access_codes/update"

Defined in

src/seam-os/routes.ts:179

---

/access_passes/create

• /access_passes/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.building_id?	string
jsonBody.building_ids?	string[]
jsonBody.can_use_access_code?	boolean
jsonBody.can_use_remote_unlock?	boolean
jsonBody.device_group_id?	string
jsonBody.devices?	{ can_use_access_code?: boolean ; can_use_remote_unlock?: boolean ; device_id: string }[]
jsonBody.ends_at?	string | Date
jsonBody.grant_mixed_building_device_access?	boolean
jsonBody.name	string
jsonBody.starts_at?	string | Date
jsonResponse	Object
jsonResponse.access_pass	Object
jsonResponse.access_pass.access_pass_id	string
jsonResponse.access_pass.access_pass_name	string
jsonResponse.access_pass.created_at	string | Date
jsonResponse.access_pass.device_count	number
jsonResponse.access_pass.does_not_end	boolean
jsonResponse.access_pass.ends_at	null | string | Date
jsonResponse.access_pass.last_used_at	null | string | Date
jsonResponse.access_pass.organization_id	string
jsonResponse.access_pass.starts_at	string | Date
jsonResponse.access_pass.url	string
method	"POST"
queryParams	Object
route	"/access_passes/create"

Defined in

src/seam-os/routes.ts:195

---

/access_passes/create_from_access_code

• /access_passes/create_from_access_code: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.access_code_id	string
jsonBody.can_use_remote_unlock?	boolean
jsonResponse	Object
jsonResponse.access_pass	Object
jsonResponse.access_pass.access_pass_id	string
jsonResponse.access_pass.access_pass_name	string
jsonResponse.access_pass.created_at	string | Date
jsonResponse.access_pass.device_count	number
jsonResponse.access_pass.does_not_end	boolean
jsonResponse.access_pass.ends_at	null | string | Date
jsonResponse.access_pass.last_used_at	null | string | Date
jsonResponse.access_pass.organization_id	string
jsonResponse.access_pass.starts_at	string | Date
jsonResponse.access_pass.url	string
method	"POST"
queryParams	Object
route	"/access_passes/create_from_access_code"

Defined in

src/seam-os/routes.ts:234

---

/access_passes/delete

• /access_passes/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/access_passes/delete"

Defined in

src/seam-os/routes.ts:259

---

/access_passes/get

• /access_passes/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_pass	Object
jsonResponse.access_pass.access_pass_id	string
jsonResponse.access_pass.access_pass_name	string
jsonResponse.access_pass.created_at	string | Date
jsonResponse.access_pass.device_count	number
jsonResponse.access_pass.does_not_end	boolean
jsonResponse.access_pass.ends_at	null | string | Date
jsonResponse.access_pass.last_used_at	null | string | Date
jsonResponse.access_pass.organization_id	string
jsonResponse.access_pass.starts_at	string | Date
jsonResponse.access_pass.url	string
method	"POST" | "GET"
queryParams	Object
route	"/access_passes/get"

Defined in

src/seam-os/routes.ts:270

---

/access_passes/get_count_summary

• /access_passes/get_count_summary: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id	string
commonParams.end?	string | Date
commonParams.start	string | Date
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_pass_counts	Object
jsonResponse.access_pass_counts.total_uses	number
jsonResponse.access_pass_counts.uses_in_period	number
method	"POST" | "GET"
queryParams	Object
route	"/access_passes/get_count_summary"

Defined in

src/seam-os/routes.ts:294

---

/access_passes/list

• /access_passes/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.device_id?	string
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.access_passes	{ access_pass_id: string ; access_pass_name: string ; created_at: string | Date ; device_count: number ; does_not_end: boolean ; ends_at: null | string | Date ; last_used_at: null | string | Date ; organization_id: string ; starts_at: string | Date ; url: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/access_passes/list"

Defined in

src/seam-os/routes.ts:312

---

/access_passes/list_accessible_devices

• /access_passes/list_accessible_devices: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.accessible_devices	{ access_code_id: null | string ; can_use_access_code: boolean ; can_use_remote_unlock: boolean ; code: null | string ; device_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/access_passes/list_accessible_devices"

Defined in

src/seam-os/routes.ts:338

---

/access_passes/update

• /access_passes/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	{ access_method_flags?: { can_use_access_code: boolean ; can_use_remote_unlock: boolean } ; access_pass_id: string ; device_group_id?: string ; devices?: { can_use_access_code?: boolean ; can_use_remote_unlock?: boolean ; device_id: string }[] ; ends_at?: null | string | Date ; starts_at?: string | Date } | { access_pass_id: string ; devices: { can_use_access_code?: boolean ; can_use_remote_unlock?: boolean ; device_id: string }[] ; ends_at?: null | string | Date ; starts_at?: string | Date } | { access_pass_id: string ; can_use_access_code: boolean ; can_use_remote_unlock: boolean ; device_group_id: string ; ends_at?: null | string | Date ; starts_at?: string | Date }
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/access_passes/update"

Defined in

src/seam-os/routes.ts:357

---

/buildings/add_device

• /buildings/add_device: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.building_id	string
jsonBody.device_id	string
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/buildings/add_device"

Defined in

src/seam-os/routes.ts:403

---

/buildings/add_user

• /buildings/add_user: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	{ building_id: string ; user_id: string } | { building_id: string ; email: string }
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/buildings/add_user"

Defined in

src/seam-os/routes.ts:415

---

/buildings/create

• /buildings/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.ext_google_place_id	string
jsonBody.image_url?	string
jsonBody.name	string
jsonBody.timezone	string
jsonResponse	Object
jsonResponse.building	Object
jsonResponse.building.building_id	string
jsonResponse.building.created_at	string | Date
jsonResponse.building.image_url	null | string
jsonResponse.building.location	Object
jsonResponse.building.location.addr1	string
jsonResponse.building.location.addr2	null | string
jsonResponse.building.location.city	string
jsonResponse.building.location.country	string
jsonResponse.building.location.ext_google_place_id	null | string
jsonResponse.building.location.full_address_string	string
jsonResponse.building.location.latitude	number
jsonResponse.building.location.longitude	number
jsonResponse.building.location.state	string
jsonResponse.building.location.zip_code	string
jsonResponse.building.name	string
jsonResponse.building.organization_id	string
jsonResponse.building.timezone	string
method	"POST"
queryParams	Object
route	"/buildings/create"

Defined in

src/seam-os/routes.ts:432

---

/buildings/delete

• /buildings/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/buildings/delete"

Defined in

src/seam-os/routes.ts:467

---

/buildings/get

• /buildings/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.building	Object
jsonResponse.building.building_id	string
jsonResponse.building.created_at	string | Date
jsonResponse.building.image_url	null | string
jsonResponse.building.location	Object
jsonResponse.building.location.addr1	string
jsonResponse.building.location.addr2	null | string
jsonResponse.building.location.city	string
jsonResponse.building.location.country	string
jsonResponse.building.location.ext_google_place_id	null | string
jsonResponse.building.location.full_address_string	string
jsonResponse.building.location.latitude	number
jsonResponse.building.location.longitude	number
jsonResponse.building.location.state	string
jsonResponse.building.location.zip_code	string
jsonResponse.building.name	string
jsonResponse.building.organization_id	string
jsonResponse.building.timezone	string
method	"POST" | "GET"
queryParams	Object
route	"/buildings/get"

Defined in

src/seam-os/routes.ts:478

---

/buildings/get_count_summary

• /buildings/get_count_summary: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.end?	string | Date
commonParams.start?	string | Date
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.building_count_summary	Object
jsonResponse.building_count_summary.active_access_passes	number
jsonResponse.building_count_summary.device_incidents	number
jsonResponse.building_count_summary.devices	number
jsonResponse.building_count_summary.incidents	number
jsonResponse.building_count_summary.low_battery_incidents	number
jsonResponse.building_count_summary.offline_account_incidents	number
method	"POST" | "GET"
queryParams	Object
route	"/buildings/get_count_summary"

Defined in

src/seam-os/routes.ts:510

---

/buildings/list

• /buildings/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.buildings	{ building_id: string ; created_at: string | Date ; image_url: null | string ; location: { addr1: string ; addr2: null | string ; city: string ; country: string ; ext_google_place_id: null | string ; full_address_string: string ; latitude: number ; longitude: number ; state: string ; zip_code: string } ; name: string ; organization_id: string ; timezone: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/buildings/list"

Defined in

src/seam-os/routes.ts:532

---

/buildings/list_count_summaries

• /buildings/list_count_summaries: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_ids	string[]
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.building_count_summaries	{ active_access_passes: number ; devices: number ; incidents: number }[]
method	"POST" | "GET"
queryParams	Object
route	"/buildings/list_count_summaries"

Defined in

src/seam-os/routes.ts:564

---

/buildings/remove_device

• /buildings/remove_device: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
commonParams.device_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/buildings/remove_device"

Defined in

src/seam-os/routes.ts:581

---

/buildings/remove_user

• /buildings/remove_user: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/buildings/remove_user"

Defined in

src/seam-os/routes.ts:593

---

/buildings/update

• /buildings/update: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
commonParams.ext_google_place_id?	string
commonParams.image_url?	string
commonParams.name?	string
commonParams.timezone?	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/buildings/update"

Defined in

src/seam-os/routes.ts:605

---

/buildings/update_user_role

• /buildings/update_user_role: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id	string
commonParams.building_roles	("building:manager" | "building:operator")[]
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/buildings/update_user_role"

Defined in

src/seam-os/routes.ts:620

---

/device_groups/create

• /device_groups/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.device_ids?	string[]
jsonBody.name	string
jsonResponse	Object
jsonResponse.device_group	Object
jsonResponse.device_group.created_at	string | Date
jsonResponse.device_group.device_group_id	string
jsonResponse.device_group.device_ids	string[]
jsonResponse.device_group.name	string
jsonResponse.device_group.organization_id	string
method	"POST"
queryParams	Object
route	"/device_groups/create"

Defined in

src/seam-os/routes.ts:633

---

/device_groups/delete

• /device_groups/delete: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.device_group_id	string
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/device_groups/delete"

Defined in

src/seam-os/routes.ts:653

---

/device_groups/get

• /device_groups/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.device_group_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.device_group	Object
jsonResponse.device_group.created_at	string | Date
jsonResponse.device_group.device_group_id	string
jsonResponse.device_group.device_ids	string[]
jsonResponse.device_group.name	string
jsonResponse.device_group.organization_id	string
method	"POST" | "GET"
queryParams	Object
route	"/device_groups/get"

Defined in

src/seam-os/routes.ts:664

---

/device_groups/list

• /device_groups/list: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.device_groups	{ created_at: string | Date ; device_group_id: string ; device_ids: string[] ; name: string ; organization_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/device_groups/list"

Defined in

src/seam-os/routes.ts:683

---

/device_groups/update

• /device_groups/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.device_group_id	string
jsonBody.device_ids?	string[]
jsonBody.name?	string
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/device_groups/update"

Defined in

src/seam-os/routes.ts:700

---

/devices/delete

• /devices/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.device_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/devices/delete"

Defined in

src/seam-os/routes.ts:713

---

/devices/get

• /devices/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.device_id?	string
commonParams.device_name?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.device	Object
jsonResponse.device.building_id	null | string
jsonResponse.device.created_at	string
jsonResponse.device.device_id	string
jsonResponse.device.device_type	string
jsonResponse.device.errors	unknown[]
jsonResponse.device.linked_account_id	string
jsonResponse.device.name	string
jsonResponse.device.properties	Object
jsonResponse.device.warnings	unknown[]
method	"POST" | "GET"
queryParams	Object
route	"/devices/get"

Defined in

src/seam-os/routes.ts:724

---

/devices/get_count_summary

• /devices/get_count_summary: Object

Type declaration

Name	Type
commonParams	Object
commonParams.device_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.device_count_summary	Object
jsonResponse.device_count_summary.active_access_passes	number
method	"POST" | "GET"
queryParams	Object
route	"/devices/get_count_summary"

Defined in

src/seam-os/routes.ts:751

---

/devices/list

• /devices/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.device_ids?	string[]
commonParams.has_no_building?	boolean
commonParams.linked_account_id?	string
commonParams.query?	string
commonParams.user_group_id?	string
commonParams.user_id?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.devices	{ building_id: null | string ; created_at: string ; device_id: string ; device_type: string ; errors: unknown[] ; linked_account_id: string ; name: string ; properties: { [x: string]: unknown; } ; warnings: unknown[] }[]
method	"POST" | "GET"
queryParams	Object
route	"/devices/list"

Defined in

src/seam-os/routes.ts:766

---

/devices/list_counts

• /devices/list_counts: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.linked_account_id?	string
commonParams.organization_id?	string
commonParams.queries	string[]
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.device_counts	{ count: number ; query: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/devices/list_counts"

Defined in

src/seam-os/routes.ts:797

---

/devices/update

• /devices/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	{ building_id?: string ; device_id: string ; location?: {} ; name?: string } | { building_id?: string ; device_ids: string[] ; location?: {} ; name?: string }
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/devices/update"

Defined in

src/seam-os/routes.ts:816

---

/events/get_count_summary

• /events/get_count_summary: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id?	string
commonParams.between?	(string | Date)[]
commonParams.building_id?	string
commonParams.device_id?	string
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.event_count_summary	Object
jsonResponse.event_count_summary.access_pass_events	number
jsonResponse.event_count_summary.battery_events	number
jsonResponse.event_count_summary.connection_events	number
jsonResponse.event_count_summary.lock_unlock_events	number
method	"POST" | "GET"
queryParams	Object
route	"/events/get_count_summary"

Defined in

src/seam-os/routes.ts:837

---

/events/list

• /events/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_pass_id?	string
commonParams.between?	(string | Date)[]
commonParams.building_id?	string
commonParams.device_id?	string
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.events	({ event_id: string ; event_type: "linked_account.connected" ; linked_account_id: string ; occurred_at: string | Date ; organization_id: string } | { event_id: string ; event_type: "linked_account.completed_first_sync" ; linked_account_id: string ; occurred_at: string | Date ; organization_id: string } | { device_id: string ; event_id: string ; event_type: "device.connected" ; occurred_at: string | Date ; organization_id: string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.disconnected" ; occurred_at: string | Date ; organization_id: string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.tampered" ; occurred_at: string | Date ; organization_id: string } | { access_pass_id: string ; building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.unlocked" ; method: "access_pass" ; occurred_at: string | Date ; organization_id: string ; user_id: null | string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.unlocked" ; method: "manual" ; occurred_at: string | Date ; organization_id: string ; user_id: string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.unlocked" ; method: "keycode" | "unknown" ; occurred_at: string | Date ; organization_id: string } | { access_pass_id: string ; building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.locked" ; method: "access_pass" ; occurred_at: string | Date ; organization_id: string ; user_id: null | string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.locked" ; method: "manual" ; occurred_at: string | Date ; organization_id: string ; user_id: string } | { building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.locked" ; method: "keycode" | "unknown" ; occurred_at: string | Date ; organization_id: string } | { battery_level: number ; building_id: null | string ; device_id: string ; event_id: string ; event_type: "device.low_battery" ; occurred_at: string | Date ; organization_id: string } | { access_pass_id: string ; building_id: null | string ; event_id: string ; event_type: "access_pass.used" ; occurred_at: string | Date ; organization_id: string ; user_id: null | string } | { access_code_id: string ; device_id: string ; event_id: string ; event_type: "access_code.created" ; occurred_at: string | Date ; organization_id: string } | { access_code_id: string ; device_id: string ; event_id: string ; event_type: "access_code.deleted" ; occurred_at: string | Date ; organization_id: string })[]
method	"POST" | "GET"
queryParams	Object
route	"/events/list"

Defined in

src/seam-os/routes.ts:859

---

/health

• /health: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "GET"
queryParams	Object
route	"/health"

Defined in

src/seam-os/routes.ts:1008

---

/incidents/list

• /incidents/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.access_code_id?	string
commonParams.access_pass_id?	string
commonParams.between?	(string | Date)[]
commonParams.building_id?	string
commonParams.device_id?	string
commonParams.device_ids?	string[]
commonParams.is_resolved?	boolean
commonParams.linked_account_id?	string
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.incidents	{ access_code_id: null | string ; access_pass_id: null | string ; building_id: null | string ; created_at: string | Date ; device_id: null | string ; ended_at: null | string | Date ; incident_id: string ; incident_type: string ; is_resolved: boolean ; linked_account_id: null | string ; organization_id: string ; started_at: string | Date }[]
method	"POST" | "GET"
queryParams	Object
route	"/incidents/list"

Defined in

src/seam-os/routes.ts:1017

---

/linked_accounts/delete

• /linked_accounts/delete: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.linked_account_id	string
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/linked_accounts/delete"

Defined in

src/seam-os/routes.ts:1051

---

/linked_accounts/get

• /linked_accounts/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.linked_account_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.linked_account	Object
jsonResponse.linked_account.account_type	string
jsonResponse.linked_account.created_at	string | Date
jsonResponse.linked_account.device_count	number
jsonResponse.linked_account.did_complete_first_sync	boolean
jsonResponse.linked_account.errors	{ error_code: string ; message: string }[]
jsonResponse.linked_account.ext_seam_connected_account_id	string
jsonResponse.linked_account.linked_account_id	string
jsonResponse.linked_account.organization_id	string
jsonResponse.linked_account.user_identifier?	any
jsonResponse.linked_account.warnings	{ message: string ; warning_code: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/linked_accounts/get"

Defined in

src/seam-os/routes.ts:1062

---

/linked_accounts/get_counts

• /linked_accounts/get_counts: Object

Type declaration

Name	Type
commonParams	Object
commonParams.queries	string[]
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.counts	{ count: number ; query: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/linked_accounts/get_counts"

Defined in

src/seam-os/routes.ts:1092

---

/linked_accounts/list

• /linked_accounts/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.query?	string
commonParams.since?	string | Date
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.linked_accounts	{ account_type: string ; created_at: string | Date ; device_count: number ; did_complete_first_sync: boolean ; errors: { error_code: string ; message: string }[] ; ext_seam_connected_account_id: string ; linked_account_id: string ; organization_id: string ; user_identifier?: any ; warnings: { message: string ; warning_code: string }[] }[]
method	"POST" | "GET"
queryParams	Object
route	"/linked_accounts/list"

Defined in

src/seam-os/routes.ts:1108

---

/locks/lock

• /locks/lock: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.access_pass_id?	string
jsonBody.device_id	string
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/locks/lock"

Defined in

src/seam-os/routes.ts:1139

---

/locks/unlock

• /locks/unlock: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.access_pass_id?	string
jsonBody.device_id	string
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/locks/unlock"

Defined in

src/seam-os/routes.ts:1151

---

/login_portals/create

• /login_portals/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.accepted_providers?	string[]
jsonBody.custom_redirect_url?	string
jsonBody.device_selection_mode?	"none" | "single" | "multiple"
jsonResponse	Object
jsonResponse.login_portal	Object
jsonResponse.login_portal.created_at	string | Date
jsonResponse.login_portal.linked_account_id	null | string
jsonResponse.login_portal.login_portal_id	string
jsonResponse.login_portal.login_successful	boolean
jsonResponse.login_portal.organization_id	string
jsonResponse.login_portal.status	"pending" | "authorized"
jsonResponse.login_portal.view_url	string
method	"POST"
queryParams	Object
route	"/login_portals/create"

Defined in

src/seam-os/routes.ts:1163

---

/login_portals/delete

• /login_portals/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.login_portal_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/login_portals/delete"

Defined in

src/seam-os/routes.ts:1186

---

/login_portals/get

• /login_portals/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.login_portal_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.login_portal	Object
jsonResponse.login_portal.created_at	string | Date
jsonResponse.login_portal.linked_account_id	null | string
jsonResponse.login_portal.login_portal_id	string
jsonResponse.login_portal.login_successful	boolean
jsonResponse.login_portal.organization_id	string
jsonResponse.login_portal.status	"pending" | "authorized"
jsonResponse.login_portal.view_url	string
method	"POST" | "GET"
queryParams	Object
route	"/login_portals/get"

Defined in

src/seam-os/routes.ts:1197

---

/login_portals/list

• /login_portals/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.since?	string | Date
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.login_portals	{ created_at: string | Date ; linked_account_id: null | string ; login_portal_id: string ; login_successful: boolean ; organization_id: string ; status: "pending" | "authorized" ; view_url: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/login_portals/list"

Defined in

src/seam-os/routes.ts:1218

---

/organizations/create

• /organizations/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.is_sandbox?	boolean
jsonBody.name	string
jsonResponse	Object
jsonResponse.organization	Object
jsonResponse.organization.created_at	string | Date
jsonResponse.organization.created_by	null | string
jsonResponse.organization.name	string
jsonResponse.organization.organization_id	string
method	"POST"
queryParams	Object
route	"/organizations/create"

Defined in

src/seam-os/routes.ts:1239

---

/organizations/get

• /organizations/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.organization_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.organization	Object
jsonResponse.organization.created_at	string | Date
jsonResponse.organization.created_by	null | string
jsonResponse.organization.name	string
jsonResponse.organization.organization_id	string
method	"POST" | "GET"
queryParams	Object
route	"/organizations/get"

Defined in

src/seam-os/routes.ts:1258

---

/organizations/get_count_summary

• /organizations/get_count_summary: Object

Type declaration

Name	Type
commonParams	Object
commonParams.between	(string | Date)[]
commonParams.organization_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.organization_counts	Object
jsonResponse.organization_counts.incidents_in_period	number
jsonResponse.organization_counts.total_active_access_passes	number
jsonResponse.organization_counts.total_admins	number
jsonResponse.organization_counts.total_buildings	number
jsonResponse.organization_counts.total_devices	number
jsonResponse.organization_counts.total_linked_accounts	number
jsonResponse.organization_counts.total_members	number
jsonResponse.organization_counts.total_online_devices	number
jsonResponse.organization_counts.total_super_admins	number
method	"POST" | "GET"
queryParams	Object
route	"/organizations/get_count_summary"

Defined in

src/seam-os/routes.ts:1276

---

/organizations/invite_user

• /organizations/invite_user: Object

Type declaration

Name	Type
commonParams	{ email: string ; role: "org:superadmin" | "org:admin" | "org:member" ; user_id?: string } | { email?: string ; role: "org:superadmin" | "org:admin" | "org:member" ; user_id: string }
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/organizations/invite_user"

Defined in

src/seam-os/routes.ts:1300

---

/organizations/list

• /organizations/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.query?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.organizations	{ created_at: string | Date ; created_by: null | string ; name: string ; organization_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/organizations/list"

Defined in

src/seam-os/routes.ts:1319

---

/organizations/pending_users/delete

• /organizations/pending_users/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.organization_invitation_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/organizations/pending_users/delete"

Defined in

src/seam-os/routes.ts:1337

---

/organizations/pending_users/list

• /organizations/pending_users/list: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.pending_users	{ created_at: string | Date ; email: null | string ; organization_id: string ; organization_invitation_id: string ; role: "org:superadmin" | "org:admin" | "org:member" ; status: "pending" | "accepted" | "declined" ; user_id: null | string }[]
method	"POST" | "GET"
queryParams	Object
route	"/organizations/pending_users/list"

Defined in

src/seam-os/routes.ts:1348

---

/organizations/pending_users/resend_invitation

• /organizations/pending_users/resend_invitation: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.organization_invitation_id	string
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/organizations/pending_users/resend_invitation"

Defined in

src/seam-os/routes.ts:1367

---

/organizations/pending_users/update

• /organizations/pending_users/update: Object

Type declaration

Name	Type
commonParams	Object
commonParams.organization_invitation_id	string
commonParams.role	"org:superadmin" | "org:admin" | "org:member"
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/organizations/pending_users/update"

Defined in

src/seam-os/routes.ts:1378

---

/organizations/remove_user

• /organizations/remove_user: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/organizations/remove_user"

Defined in

src/seam-os/routes.ts:1390

---

/organizations/update

• /organizations/update: Object

Type declaration

Name	Type
commonParams	Object
commonParams.ext_seam_connect_api_key?	string
commonParams.name?	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/organizations/update"

Defined in

src/seam-os/routes.ts:1401

---

/organizations/update_user_role

• /organizations/update_user_role: Object

Type declaration

Name	Type
commonParams	Object
commonParams.can_view_all_buildings?	boolean
commonParams.organization_roles?	("org:superadmin" | "org:admin" | "org:member")[]
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/organizations/update_user_role"

Defined in

src/seam-os/routes.ts:1413

---

/user_groups/add_user

• /user_groups/add_user: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.user_group_id	string
jsonBody.user_id	string
jsonResponse	Object
method	"POST"
queryParams	Object
route	"/user_groups/add_user"

Defined in

src/seam-os/routes.ts:1428

---

/user_groups/create

• /user_groups/create: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.name	string
jsonResponse	Object
jsonResponse.user_group	Object
jsonResponse.user_group.created_at	string | Date
jsonResponse.user_group.name	string
jsonResponse.user_group.organization_id	string
jsonResponse.user_group.user_group_id	string
method	"POST"
queryParams	Object
route	"/user_groups/create"

Defined in

src/seam-os/routes.ts:1440

---

/user_groups/delete

• /user_groups/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_group_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/user_groups/delete"

Defined in

src/seam-os/routes.ts:1458

---

/user_groups/get

• /user_groups/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_group_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.user_group	Object
jsonResponse.user_group.created_at	string | Date
jsonResponse.user_group.name	string
jsonResponse.user_group.organization_id	string
jsonResponse.user_group.user_group_id	string
method	"POST" | "GET"
queryParams	Object
route	"/user_groups/get"

Defined in

src/seam-os/routes.ts:1469

---

/user_groups/list

• /user_groups/list: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.user_groups	{ created_at: string | Date ; name: string ; organization_id: string ; user_group_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/user_groups/list"

Defined in

src/seam-os/routes.ts:1487

---

/user_groups/remove_user

• /user_groups/remove_user: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_group_id	string
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE" | "PATCH"
queryParams	Object
route	"/user_groups/remove_user"

Defined in

src/seam-os/routes.ts:1503

---

/user_groups/update

• /user_groups/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.name?	string
jsonBody.user_group_id	string
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/user_groups/update"

Defined in

src/seam-os/routes.ts:1515

---

/users/delete

• /users/delete: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
method	"POST" | "DELETE"
queryParams	Object
route	"/users/delete"

Defined in

src/seam-os/routes.ts:1527

---

/users/get

• /users/get: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.user	Object
jsonResponse.user.created_at	string | Date
jsonResponse.user.email	null | string
jsonResponse.user.first_name	null | string
jsonResponse.user.last_name	null | string
jsonResponse.user.organization_id?	string
jsonResponse.user.user_id	string
method	"POST" | "GET"
queryParams	Object
route	"/users/get"

Defined in

src/seam-os/routes.ts:1538

---

/users/get_building_roles

• /users/get_building_roles: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_id	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.user_building_roles	{ building_id: string ; building_name: string ; building_roles: ("building:manager" | "building:operator")[] ; created_at: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/users/get_building_roles"

Defined in

src/seam-os/routes.ts:1558

---

/users/list

• /users/list: Object

Type declaration

Name	Type
commonParams	Object
commonParams.building_id?	string
commonParams.user_group_id?	string
commonParams.user_id?	string
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.users	{ created_at: string | Date ; email: null | string ; first_name: null | string ; last_name: null | string ; organization_id?: string ; user_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/users/list"

Defined in

src/seam-os/routes.ts:1576

---

/users/list_my_organizations

• /users/list_my_organizations: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.organizations_with_roles	{ organization_id: string ; organization_name: string ; user_organization_roles: string[] }[]
method	"POST" | "GET"
queryParams	Object
route	"/users/list_my_organizations"

Defined in

src/seam-os/routes.ts:1598

---

/users/list_organization_roles

• /users/list_organization_roles: Object

Type declaration

Name	Type
commonParams	Object
commonParams.user_ids?	string[]
formData	Object
jsonBody	Object
jsonResponse	Object
jsonResponse.user_organization_roles	{ can_view_all_buildings: boolean ; organization_roles: ("org:superadmin" | "org:admin" | "org:member")[] ; user_id: string }[]
method	"POST" | "GET"
queryParams	Object
route	"/users/list_organization_roles"

Defined in

src/seam-os/routes.ts:1613

---

/users/update

• /users/update: Object

Type declaration

Name	Type
commonParams	Object
formData	Object
jsonBody	Object
jsonBody.first_name?	string
jsonBody.last_name?	string
jsonBody.user_id?	string
jsonResponse	Object
method	"POST" | "PATCH"
queryParams	Object
route	"/users/update"

Defined in

src/seam-os/routes.ts:1630