Skip to main content

​
Organizations

​
list

List all organizations you have access to. 
client.organizations.list(
    limit=10,
    cursor="abc123"
)
​
limit
int
Maximum number of items to return per page
​
cursor
str
Pagination cursor for fetching the next page
​
data
List[Organization]
List of organization objects
​
next_cursor
str | None
Cursor for the next page, or None if no more results

​
get

Retrieve a specific organization by slug. 
client.organizations.get("acme-corp")
​
slug
str
required
Unique slug identifier of the organization
​
slug
str
Unique slug identifier
​
name
str
Organization name
​
description
str
Organization description
​
website
str
Organization website URL
​
industry
str
Industry category

​
create

Create a new organization. 
client.organizations.create(
    name="Acme Corporation",
    description="Leading AI solutions provider",
    website="https://acme.com",
    industry="technology",
    email="[email protected]",
    phone="+1-555-0100",
    visibility="public"
)
​
name
str
required
Name of the organization
​
description
str
Description of the organization
URL to the organization logo image
​
website
str
Organization website URL
​
industry
str
Industry category (use industry_choices() to see available options)
​
email
str
Organization contact email
​
phone
str
Organization contact phone number
​
visibility
str
Organization visibility (“public” or “private”)
​
slug
str
Generated unique slug identifier
​
name
str
Organization name

​
update

Update an existing organization. 
client.organizations.update(
    "acme-corp",
    name="Acme Corporation Inc.",
    description="Updated description",
    industry="ai-ml"
)
​
slug
str
required
Unique slug identifier of the organization to update
​
name
str
Updated organization name
​
description
str
Updated description
​
logo
str
Updated logo URL
​
website
str
Updated website URL
​
handle
str
Updated handle/slug
​
industry
str
Updated industry category
​
email
str
Updated contact email
​
phone
str
Updated contact phone
​
visibility
str
Updated visibility setting

​
delete

Delete an organization. 
client.organizations.delete("acme-corp")
​
slug
str
required
Unique slug identifier of the organization to delete

​
industry_choices

Get available industry category options. 
client.organizations.industry_choices()
​
choices
dict
Dictionary of available industry categories

​
Members

​
list_members

List members of an organization. 
client.organizations.list_members(
    "acme-corp",
    search="john",
    role="admin",
    limit=10,
    cursor="abc123"
)
​
slug
str
required
Organization slug
​
search
str
Search query to filter members by name or email
​
role
str
Filter by role (e.g., “admin”, “member”)
​
limit
int
Maximum number of items to return per page
​
cursor
str
Pagination cursor
​
data
List[OrganizationMember]
List of organization member objects

​
remove_member

Remove a member from the organization. 
client.organizations.remove_member("acme-corp", "user_xyz789")
​
slug
str
required
Organization slug
​
user_uid
str
required
UID of the user to remove

​
update_member_role

Update a member’s role in the organization. 
client.organizations.update_member_role(
    "acme-corp",
    "user_xyz789",
    role="admin"
)
​
slug
str
required
Organization slug
​
user_uid
str
required
UID of the user
​
role
str
required
New role for the member (e.g., “admin”, “member”)

​
leave

Leave an organization (current user). 
client.organizations.leave("acme-corp")
​
slug
str
required
Organization slug to leave

​
transfer_ownership

Transfer organization ownership to another member. 
client.organizations.transfer_ownership(
    "acme-corp",
    new_owner_uid="user_xyz789"
)
​
slug
str
required
Organization slug
​
new_owner_uid
str
required
UID of the user who will become the new owner

​
Invitations

​
list_invitations

List pending invitations for an organization. 
client.organizations.list_invitations("acme-corp")
​
slug
str
required
Organization slug
​
invitations
List[Invitation]
List of pending invitation objects

​
create_invitation

Invite a new member to the organization. 
client.organizations.create_invitation(
    "acme-corp",
    email="[email protected]",
    role="member"
)
​
slug
str
required
Organization slug
​
email
str
required
Email address of the person to invite
​
role
str
Role to assign (default: “member”)
​
uid
str
Unique identifier for the invitation
​
email
str
Email address invited
​
role
str
Assigned role

​
resend_invitation

Resend an invitation email. 
client.organizations.resend_invitation("acme-corp", "inv_abc123")
​
slug
str
required
Organization slug
​
invitation_uid
str
required
UID of the invitation to resend

​
cancel_invitation

Cancel a pending invitation. 
client.organizations.cancel_invitation("acme-corp", "inv_abc123")
​
slug
str
required
Organization slug
​
invitation_uid
str
required
UID of the invitation to cancel

​
Teams

​
list_teams

List all teams in an organization. 
client.organizations.list_teams("acme-corp")
​
slug
str
required
Organization slug
​
teams
List[Team]
List of team objects

​
create_team

Create a new team within an organization. 
client.organizations.create_team(
    "acme-corp",
    name="Engineering",
    description="Engineering team",
    color="#3B82F6"
)
​
slug
str
required
Organization slug
​
name
str
required
Name for the team
​
description
str
Team description
​
color
str
Hex color code for the team (e.g., “#3B82F6”)
​
slug
str
Generated team slug
​
name
str
Team name

​
get_team

Retrieve a specific team. 
client.organizations.get_team("acme-corp", "engineering")
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug

​
update_team

Update a team’s information. 
client.organizations.update_team(
    "acme-corp",
    "engineering",
    name="Platform Engineering",
    description="Updated description"
)
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug to update
​
name
str
Updated team name
​
description
str
Updated description
​
color
str
Updated color

​
delete_team

Delete a team. 
client.organizations.delete_team("acme-corp", "engineering")
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug to delete

​
Team Members

​
list_team_members

List members of a team. 
client.organizations.list_team_members("acme-corp", "engineering")
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug
​
members
List[TeamMember]
List of team member objects

​
add_team_member

Add a member to a team. 
client.organizations.add_team_member(
    "acme-corp",
    "engineering",
    user_uid="user_xyz789",
    role="member"
)
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug
​
user_uid
str
required
UID of the user to add
​
role
str
Role within the team (default: “member”)

​
remove_team_member

Remove a member from a team. 
client.organizations.remove_team_member(
    "acme-corp",
    "engineering",
    "user_xyz789"
)
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug
​
user_uid
str
required
UID of the user to remove

​
update_team_member_role

Update a team member’s role. 
client.organizations.update_team_member_role(
    "acme-corp",
    "engineering",
    "user_xyz789",
    role="lead"
)
​
slug
str
required
Organization slug
​
team_slug
str
required
Team slug
​
user_uid
str
required
UID of the user
​
role
str
required
New role for the team member

Build docs developers (and LLMs) love

Get started for freeTalk to us