Get an Organization | Edgenivo REST API

APIs & SDKs

Get an Organization

GET/__remote/api.vercel.com/v1/organizations/{organizationId}

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

/__remote/api.vercel.com/v1/organizations/{organizationId}

const response = await fetch('/__remote/api.vercel.com/v1/organizations/organizationId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "avatar": "string",
  "createdAt": "string",
  "name": "Example Name",
  "organizationId": "example_id",
  "slug": "string",
  "teamCount": "123",
  "teamId": "example_id",
  "updatedAt": "string",
  "userRole": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

organizationIdstringRequired

The ID or slug of the organization to retrieve.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

avatarstringRequired

createdAtstringRequired

namestringOptional

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.

organizationIdstringRequired

slugstringRequired

teamCountnumberRequired

teamIdstringRequired

updatedAtstringRequired

userRolestringOptional

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

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

/__remote/api.vercel.com/v1/organizations/{organizationId}

const response = await fetch('/__remote/api.vercel.com/v1/organizations/organizationId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "avatar": "string",
  "createdAt": "string",
  "name": "Example Name",
  "organizationId": "example_id",
  "slug": "string",
  "teamCount": "123",
  "teamId": "example_id",
  "updatedAt": "string",
  "userRole": "string"
}

OpenAPI Specification