REST API endpoints for Organizations
Create an organization
Section titled “Create an organization”/orgs Create a new organization owned by the authenticated user.
Authentication is required.
Access token must have org:create scope.
slug string Required The slug of the organization, used for vanity URLs. Case-insensitive.
Regex: /^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i
name string Required The display name of the organization.
Regex: /^[p{L}p{N} _-]+$/u
bio string Optional short description of the organization.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
id string Required The unique identifier of the organization.
name string Required The display name of the organization.
slug string Required The slug of the organization, used for vanity URLs.
bio string The short description of the organization.
icon_url string Required The URL of the organization icon.
created_at string Required ISO 8601 timestamp for when the organization was created.
member_count number Required The number of accepted members in the organization.
Get an organization
Section titled “Get an organization”/orgs/{orgId} orgId string Required The slug or ID of the organization.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
id string Required The unique identifier of the organization.
name string Required The display name of the organization.
slug string Required The slug of the organization, used for vanity URLs.
bio string The short description of the organization.
icon_url string URL to the organization avatar, derived from the icon API.
created_at string Required ISO 8601 timestamp for when the organization was created.
member_count number The number of accepted members in the organization.
Update an organization
Section titled “Update an organization”/orgs/{orgId} Authentication is required.
Access token must have org:update scope and the authenticated user must be the owner of the organization.
orgId string Required The slug or ID of the organization.
Only the provided fields will be updated. To remove an optional field, set it to null.
name string Required The display name of the organization.
Regex: /^[p{L}p{N} _-]+$/u
bio string Optional short description of the organization.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
id string Required The unique identifier of the organization.
name string Required The display name of the organization.
slug string Required The slug of the organization, used for vanity URLs.
bio string The short description of the organization.
icon_url string URL to the organization avatar, derived from the icon API.
created_at string Required ISO 8601 timestamp for when the organization was created.
member_count number Number of accepted members, if available.