organizations

Get an Organization

Changed on

Get a single organization by ID or slug. This endpoint is in private beta. Contact your Vercel account team for access.

get/v1/organizations/{organizationId}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/organizations/{organizationId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

The ID or slug of the organization to retrieve.

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

avatarstring nullable required
createdAtstring required
namestring

The organization's display name. Optional: organizations created before the name attribute existed have no stored value. New orgs always get one (provided or slug-derived) via the service layer.

organizationIdstring required
slugstring required
teamCountnumber required
teamIdstring required
updatedAtstring required
userRolestring

The authenticated user's role in the organization. Present on read endpoints when the user holds an organization role.

Changes