---
title: get-a-repository
product: vercel
url: /docs/rest-api/vcr/get-a-repository
canonical_url: "https://vercel.com/docs/rest-api/vcr/get-a-repository"
last_updated: 2026-09-01
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about get-a-repository on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Get a repository

```http
GET /v1/vcr/repository/{idOrName}
```

Fetch a container registry repository for a project by ID or name.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `idOrName` | string. maxLength: 255 | Yes |  |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectId` | string | Yes |  |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/vcr/repository/idOrName?projectId=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/vcr/repository/idOrName?projectId=string&teamId=string&slug=string', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X GET 'https://api.vercel.com/v1/vcr/repository/idOrName?projectId=string&teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

## Example response

```json
{
  "repository": {
    "id": "repo_a1b2c3d4e5f6",
    "projectId": "prj_a1b2c3d4e5f6",
    "name": "my-app",
    "public": "false",
    "createdAt": "2026-06-30T10:00:00.000Z",
    "updatedAt": "2026-06-30T10:00:00.000Z"
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "repository"
  ],
  "properties": {
    "repository": {
      "type": "object",
      "description": "A Vercel Container Registry repository.",
      "required": [
        "createdAt",
        "id",
        "name",
        "projectId",
        "public",
        "updatedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of the repository."
        },
        "projectId": {
          "type": "string",
          "description": "Identifier of the project the repository belongs to."
        },
        "name": {
          "type": "string",
          "description": "Name of the repository."
        },
        "public": {
          "type": "boolean",
          "description": "Whether the repository is public. Images in public repositories can be pulled by anyone. Defaults to `false` (private).",
          "enum": [
            false,
            true
          ]
        },
        "createdAt": {
          "type": "string",
          "description": "ISO 8601 timestamp of when the repository was created."
        },
        "updatedAt": {
          "type": "string",
          "description": "ISO 8601 timestamp of when the repository was last updated."
        }
      }
    }
  }
}
```

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

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: No description

### 410: No description

---

## Related

- [vcr endpoints](/docs/rest-api#vcr)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)