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.
slugstringRequiredThe slug of the organization, used for vanity URLs. Case-insensitive.
Regex: /^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i
namestringRequiredThe display name of the organization.
Regex: /^[\p{L}\p{N} _\-()]+$/u
biostringOptional short description of the organization. Maximum 256 characters.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
idstringRequiredThe unique identifier of the organization.
namestringRequiredThe display name of the organization.
slugstringRequiredThe slug of the organization, used for vanity URLs.
biostringThe short description of the organization.
icon_urlstringURL to the organization avatar, derived from the icon API.
created_atstringRequiredISO 8601 timestamp for when the organization was created.
last_slug_updated_atstringISO 8601 timestamp of the last organization slug update.
member_countnumberThe number of accepted members in the organization.
Get an organization
Section titled “Get an organization”/orgs/{orgId} orgIdstringRequiredThe 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
idstringRequiredThe unique identifier of the organization.
namestringRequiredThe display name of the organization.
slugstringRequiredThe slug of the organization, used for vanity URLs.
biostringThe short description of the organization.
icon_urlstringURL to the organization avatar, derived from the icon API.
created_atstringRequiredISO 8601 timestamp for when the organization was created.
last_slug_updated_atstringISO 8601 timestamp of the last organization slug update.
member_countnumberThe number of accepted members in the organization.
List organizations joined by a user
Section titled “List organizations joined by a user”/users/{userId}/organizations Alias: GET /users/{userId}/orgs.
Authentication may enable this endpoint return more information.
If the authenticated user is the target user, pending membership will also be included.
userIdstringRequiredThe ID or username of the user. Use @me for the current authenticated user.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
Organizations joined by the user.
idstringRequiredThe unique identifier of the organization.
namestringRequiredThe display name of the organization.
slugstringRequiredThe slug of the organization, used for vanity URLs.
biostringThe short description of the organization.
icon_urlstringURL to the organization avatar, derived from the icon API.
created_atstringRequiredISO 8601 timestamp for when the organization was created.
last_slug_updated_atstringISO 8601 timestamp of the last organization slug update.
member_countnumberThe 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.
orgIdstringRequiredThe slug or ID of the organization.
Only the provided fields will be updated. Fields are optional but not nullable.
slugstringThe slug of the organization. It can be updated only after the slug update cooldown.
Regex: /^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i
namestringThe display name of the organization.
Regex: /^[\p{L}\p{N} _\-()]+$/u
biostringOptional short description of the organization. Maximum 256 characters.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
idstringRequiredThe unique identifier of the organization.
namestringRequiredThe display name of the organization.
slugstringRequiredThe slug of the organization, used for vanity URLs.
biostringThe short description of the organization.
icon_urlstringURL to the organization avatar, derived from the icon API.
created_atstringRequiredISO 8601 timestamp for when the organization was created.
last_slug_updated_atstringISO 8601 timestamp of the last organization slug update.
member_countnumberThe number of accepted members in the organization.