API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Members

Add organization user to zone

zones.members.add(strzone_id, MemberAddParams**kwargs) -> ZoneMember

POST/zones/{zoneId}/members

List organization users in a zone

zones.members.list(strzone_id, MemberListParams**kwargs) -> MemberListResponse

GET/zones/{zoneId}/members

Get organization user in a zone

zones.members.retrieve(strorganization_user_id, MemberRetrieveParams**kwargs) -> ZoneMember

GET/zones/{zoneId}/members/{organizationUserId}

Update organization user role in a zone

zones.members.update(strorganization_user_id, MemberUpdateParams**kwargs) -> ZoneMember

PATCH/zones/{zoneId}/members/{organizationUserId}

Remove member from zone

zones.members.delete(strorganization_user_id, MemberDeleteParams**kwargs)

DELETE/zones/{zoneId}/members/{organizationUserId}

ModelsExpand Collapse

class ZoneMember: …

Represents an organization user's membership in a zone with an assigned role

id: str

Unique identifier of the zone member

_links: _Links

HAL-format hypermedia links for zone member resources

organization_user: _LinksOrganizationUser

href: str

Link to the user resource

formaturi-reference

self: _LinksSelf

href: str

Link to this zone member resource

formaturi-reference

created_at: datetime

Entity creation timestamp

formatdate-time

organization_id: str

Organization ID that owns the zone

organization_user_id: str

Organization user ID of the zone member

role: ZoneRole

Zone role type. zone_manager has full management access, zone_viewer has read-only access.

Accepts one of the following:

"zone_manager"

"zone_viewer"

updated_at: datetime

Entity update timestamp

formatdate-time

zone_id: str

Zone ID the organization user is a member of

Literal["zone_manager", "zone_viewer"]

Zone role type. zone_manager has full management access, zone_viewer has read-only access.

Accepts one of the following:

"zone_manager"

"zone_viewer"