Get Organization
Retrieve a single organization by its ID or slug.Path Parameters
The organization ID or slug
Response
The organization’s unique ID
The organization’s URL-safe slug
The organization’s name/title
The organization’s description
The ID of the organization’s team
URL to the organization’s icon
Primary color extracted from the icon (as RGB integer)
Array of team members
Example Request
Example Response
Get Multiple Organizations
Retrieve multiple organizations by their IDs or slugs.Query Parameters
JSON array of organization IDs or slugs as a string
Example Request
Create Organization
Create a new organization. Requires authentication andORGANIZATION_CREATE scope.
Request Body
URL-safe organization slug (3-64 characters, lowercase letters, numbers, hyphens)
Organization name/title (3-64 characters)
Organization description (3-256 characters)
Response
Returns the newly created organization object with the creator as the owner.Example Request
Limits
Users have a limit on the number of organizations they can create. If the limit is reached, the request will fail with aLimitReached error.
Edit Organization
Update an organization’s details. Requires authentication andORGANIZATION_WRITE scope with EDIT_DETAILS permission.
Path Parameters
The organization ID or slug
Request Body
New organization name (3-64 characters)
New URL-safe slug (3-64 characters)
New organization description (3-256 characters)
Example Request
Notes
- Slug changes must not collide with existing organization IDs or slugs
- Returns 204 No Content on success
- Requires
EDIT_DETAILSorganization permission
Delete Organization
Delete an organization. Requires authentication andORGANIZATION_DELETE scope with DELETE_ORGANIZATION permission.
Path Parameters
The organization ID or slug
Behavior
When an organization is deleted:- All projects owned by the organization are transferred to the organization owner
- The organization owner becomes the “Inherited Owner” of each project
- Organization members are removed from project teams
- The organization and its team are permanently deleted
Example Request
Get Organization Projects
List all projects owned by an organization.Path Parameters
The organization ID or slug
Response
Returns an array of project objects owned by the organization. Only includes projects visible to the requesting user.Example Request
Example Response
Add Project to Organization
Add an existing project to an organization. Requires authentication and bothPROJECT_WRITE and ORGANIZATION_WRITE scopes.
Path Parameters
The organization ID or slug
Request Body
The project ID or slug to add
Requirements
- You must be an owner of the project you’re adding
- You must have
ADD_PROJECTpermission in the organization - The project must not already belong to another organization
Behavior
When a project is added to an organization:- The project’s
organization_idis set - Former project owners lose their owner status
- The organization owner is removed from the project team
- Organization members inherit permissions to the project
Example Request
Remove Project from Organization
Remove a project from an organization and transfer it to a new owner. Requires authentication and bothPROJECT_WRITE and ORGANIZATION_WRITE scopes.
Path Parameters
The organization ID or slug
The project ID or slug to remove
Request Body
User ID of the new project owner (must be an organization member)
Requirements
- You must have
REMOVE_PROJECTpermission in the organization - The specified new owner must be a member of the organization
- The project must currently be owned by the organization
Behavior
When a project is removed:- The project’s
organization_idis set to null - The specified user becomes the project owner
- If the new owner isn’t already a project team member, they’re added as “Inherited Owner”
- Organization permissions are removed from the project
Example Request
Get Project’s Organization
Get the organization that owns a specific project.Path Parameters
The project ID or slug
Response
Returns the organization object if the project belongs to an organization, otherwise returns 404.Example Request
Update Organization Icon
Upload a new icon for the organization. Requires authentication andORGANIZATION_WRITE scope with EDIT_DETAILS permission.
Path Parameters
The organization ID or slug
Query Parameters
Image file extension (png, jpg, jpeg, gif, webp, svg)
Request Body
Binary image data (max 256 KiB)Behavior
- Deletes the old icon if one exists
- Uploads and optimizes the new icon
- Extracts a primary color from the image
- Updates the organization’s
icon_url,raw_icon_url, andcolorfields
Example Request
Delete Organization Icon
Remove the organization’s icon. Requires authentication andORGANIZATION_WRITE scope with EDIT_DETAILS permission.
Path Parameters
The organization ID or slug
Example Request
Get Organization Members
Get all members of an organization’s team.Path Parameters
The organization ID or slug
Response
Returns an array of team member objects.Example Request
Example Response
Organization Permissions
Organization members have specific permissions that control what they can do:EDIT_DETAILS- Edit organization name, slug, description, and iconMANAGE_INVITES- Invite new members to the organizationREMOVE_MEMBER- Remove members from the organizationEDIT_MEMBER- Edit member roles and permissionsADD_PROJECT- Add projects to the organizationREMOVE_PROJECT- Remove projects from the organizationDELETE_ORGANIZATION- Delete the entire organization
organization_permissions field of team members.
Common Use Cases
Creating an Organization- Call
POST /v3/organizationwith name, slug, and description - You become the organization owner automatically
- Upload an icon with
PATCH /v3/organization/{id}/icon - Invite team members using the Teams API
- You must be the owner of the project
- You must have
ADD_PROJECTpermission in the organization - Call
POST /v3/organization/{id}/projectswith the project ID - All organization members now have access to the project
- Use the standard Teams API endpoints with the organization’s
team_id - Set
organization_permissionswhen adding members - Organization owners have full permissions by default
- To move between organizations: Remove from old org, add to new org
- To make independent: Remove from org and specify new owner
- Original team members remain on the project team
