REST API endpoints for Organizations

Create an organization

POST /orgs

<p>Create a new organization owned by the authenticated user.</p>

Authentication

Authentication is required.

Access token must have <code>org:create</code> scope.

Learn more about authentication

Request Body Content-Type: application/json

slugstringRequired

<p>The slug of the organization, used for vanity URLs. Case-insensitive.<br> Regex: <code>/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i</code></p>

namestringRequired

<p>The display name of the organization.<br> Regex: <code>/^[p{L}p{N} _-]+$/u</code></p>

biostring

<p>Optional short description of the organization.</p>

Response Body Content-Type: application/json

This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more

idstringRequired

<p>The unique identifier of the organization.</p>

namestringRequired

<p>The display name of the organization.</p>

slugstringRequired

<p>The slug of the organization, used for vanity URLs.</p>

biostring

<p>The short description of the organization.</p>

icon_urlstring

<p>URL to the organization avatar, derived from the icon API.</p>

created_atstringRequired

<p>ISO 8601 timestamp for when the organization was created.</p>

member_countnumber

<p>The number of accepted members in the organization.</p>

Get an organization

GET /orgs/{orgId}

Path Parameters

orgIdstringRequired

<p>The slug or ID of the organization.</p>

Response Body Content-Type: application/json

This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more

idstringRequired

<p>The unique identifier of the organization.</p>

namestringRequired

<p>The display name of the organization.</p>

slugstringRequired

<p>The slug of the organization, used for vanity URLs.</p>

biostring

<p>The short description of the organization.</p>

icon_urlstring

<p>URL to the organization avatar, derived from the icon API.</p>

created_atstringRequired

<p>ISO 8601 timestamp for when the organization was created.</p>

member_countnumber

<p>The number of accepted members in the organization.</p>

Update an organization

PATCH /orgs/{orgId}

Authentication

Authentication is required.

Access token must have <code>org:update</code> scope and the authenticated user must be the owner of the organization.

Learn more about authentication

Path Parameters

orgIdstringRequired

<p>The slug or ID of the organization.</p>

Request Body Content-Type: application/json

<p>Only the provided fields will be updated. To remove an optional field, set it to <code>null</code>.</p>

namestringRequired

<p>The display name of the organization.<br> Regex: <code>/^[p{L}p{N} _-]+$/u</code></p>

biostring

<p>Optional short description of the organization.</p>

Response Body Content-Type: application/json

This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more

idstringRequired

<p>The unique identifier of the organization.</p>

namestringRequired

<p>The display name of the organization.</p>

slugstringRequired

<p>The slug of the organization, used for vanity URLs.</p>

biostring

<p>The short description of the organization.</p>

icon_urlstring

<p>URL to the organization avatar, derived from the icon API.</p>

created_atstringRequired

<p>ISO 8601 timestamp for when the organization was created.</p>

member_countnumber

<p>The number of accepted members in the organization.</p>