> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/vimeo/groups/group/videos/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/vimeo/groups/group/videos/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# List Vimeo group videos (https://www.socialfetch.dev/docs/api/v1/vimeo/groups/group/videos/get)

## Summary

List a Vimeo group's videos.

**Tags:** `Vimeo`

## HTTP

- **Method:** GET
- **Path:** `/v1/vimeo/groups/{group}/videos`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.vimeo.listGroupVideos({ group: "creativeapps" })`
- **Accepted identifiers:** `group` (path)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `group` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$`
- **Description:** Vimeo group slug or numeric id, e.g. `creativeapps` or `18850`.

### `page` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 20000
- **Description:** Page number, 1-20000. Default: 1. Use `page.nextCursor` to continue; a page past the last is an empty page.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 100
- **Description:** Rows per page, 1-100. Default: 25.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 512
- **Description:** Opaque cursor, 1 to 512 characters. Pass `page.nextCursor` from the previous response to get the next page; omit it to start at the first page. It is tied to the other filters.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: A page of a group's videos.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

A page of a group's videos.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the entity was found. A removed, private, password-protected or never-existing item is `not_found`; Vimeo does not distinguish them.
  - **group** (required) — type `string`. The requested group.
  - **videos** (required) — type `array`. The group's videos.
    - _items:_
      - **id** (required) — type `integer`; minimum: 0. Video id.
      - **url** (required) — type `string`; nullable. Video page URL.
      - **title** (required) — type `string`; nullable. Title.
      - **description** (required) — type `string`; nullable. Description as plain text; null when empty.
      - **descriptionHtml** (required) — type `string`; nullable. Description as Vimeo formats it, line breaks included; null when it is empty.
      - **uploadedAt** (required) — type `string`; nullable. When the video was uploaded, converted to UTC from Vimeo's US Eastern time.
      - **modifiedAt** (required) — type `string`; nullable. When the record was last changed.
      - **releasedAt** (required) — type `string`; nullable. When the owner says the video was released.
      - **durationSeconds** (required) — type `integer`; minimum: 0; nullable. Length in whole seconds.
      - **width** (required) — type `integer`; minimum: 0; nullable. Source width in pixels.
      - **height** (required) — type `integer`; minimum: 0; nullable. Source height in pixels.
      - **orientation** (required) — type `string`; enum: landscape, portrait, square, null; nullable. Derived from width and height.
      - **tags** (required) — type `array`. Tags, without the leading separator.
        - _items:_
          - type `string`
      - **categories** (required) — type `array`. Vimeo category names.
        - _items:_
          - type `string`
      - **language** (required) — type `string`; nullable. Language code the owner set.
      - **license** (required) — type `string`; nullable. Licence the owner set.
      - **contentRating** (required) — type `array`; nullable. Vimeo content-rating labels.
        - _items:_
          - type `string`
      - **privacy** (required) — type `object`; nullable. The video's privacy settings.
      - **embedPermission** (required) — type `string`; enum: anywhere, approved, nowhere, null; nullable. Where the video may be embedded.
      - **thumbnails** (required) — type `object`. Thumbnails in the sizes Vimeo offers.
      - **owner** (required) — type `object`; nullable. The user a record belongs to.
      - **stats** (required) — type `object`. Counts. Hidden counts are null, not zero.
  - **page** (required) — type `object`. Pagination state for the current page. A short page is not the end: hasMore says whether another page exists.
    - **page** (required) — type `integer`; minimum: 0. Current page number (1-based).
    - **perPage** (required) — type `integer`; minimum: 0; nullable. Rows per page, when fixed; otherwise null.
    - **total** (required) — type `integer`; minimum: 0; nullable. How many rows match; null when no total is available. Vimeo's totals drift between pages.
    - **hasMore** (required) — type `boolean`. Whether another page is available. A page can be shorter than `perPage` when a row is unavailable.
    - **nextCursor** (required) — type `string`; nullable. Opaque cursor for the next request; null on the last page or an empty page.
    - **truncated** (optional) — type `boolean`. True when Vimeo stops this list before its end, so more rows exist beyond the last page.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "group": "creativeapps",
    "videos": [
      {
        "id": 1056428684,
        "url": "https://vimeo.com/1056428684",
        "title": "Exoplanètes",
        "description": "Exoplanètes est un diaporama automatisé qui utilise des bases de données scientifiques, un ordinateur, et un synthétiseur modulaire. Pour réaliser le projet, j…",
        "descriptionHtml": "Exoplanètes est un diaporama automatisé qui utilise des bases de données scientifiques, un ordinateur, et un synthétiseur modulaire. Pour réaliser le projet, j…",
        "uploadedAt": "2025-02-13T15:08:46.000Z",
        "modifiedAt": "2026-10-31T02:26:45.000Z",
        "releasedAt": "2025-02-13T15:08:46.000Z",
        "durationSeconds": 60,
        "width": 3840,
        "height": 2160,
        "orientation": "landscape",
        "tags": [],
        "categories": [
          "Experimental"
        ],
        "language": "fr",
        "license": "by-nc-sa",
        "contentRating": [
          "safe"
        ],
        "privacy": {
          "view": "anybody",
          "embed": "public",
          "comments": "anybody"
        },
        "embedPermission": "anywhere",
        "thumbnails": {
          "small": "https://i.vimeocdn.com/video/1982178633-af7e1d014f6bd2a511b22376a18505e83e4dab029cbe78ce1492c6b219eeaa7f-d_100x75?&r=pad&region=us",
          "medium": "https://i.vimeocdn.com/video/1982178633-af7e1d014f6bd2a511b22376a18505e83e4dab029cbe78ce1492c6b219eeaa7f-d_200x150?&r=pad&region=us",
          "large": "https://i.vimeocdn.com/video/1982178633-af7e1d014f6bd2a511b22376a18505e83e4dab029cbe78ce1492c6b219eeaa7f-d_640x360?&r=pad&region=us",
          "base": "https://i.vimeocdn.com/video/1982178633-af7e1d014f6bd2a511b22376a18505e83e4dab029cbe78ce1492c6b219eeaa7f-d?region=us"
        },
        "owner": {
          "id": 1983409,
          "name": "Jean-Pierre Aubé",
          "handle": "jpaube",
          "url": "https://vimeo.com/jpaube",
          "avatar": {
            "small": "https://i.vimeocdn.com/portrait/1204488_30x30?sig=68cabdfd1c20a6c7723385b295cdc85211c610a5cee8351b5b30d5cb854d2677&v=1&region=us",
            "medium": "https://i.vimeocdn.com/portrait/1204488_75x75?sig=68cabdfd1c20a6c7723385b295cdc85211c610a5cee8351b5b30d5cb854d2677&v=1&region=us",
            "large": "https://i.vimeocdn.com/portrait/1204488_100x100?sig=68cabdfd1c20a6c7723385b295cdc85211c610a5cee8351b5b30d5cb854d2677&v=1&region=us",
            "huge": "https://i.vimeocdn.com/portrait/1204488_300x300?sig=68cabdfd1c20a6c7723385b295cdc85211c610a5cee8351b5b30d5cb854d2677&v=1&region=us",
            "base": "https://i.vimeocdn.com/portrait/1204488?sig=68cabdfd1c20a6c7723385b295cdc85211c610a5cee8351b5b30d5cb854d2677&v=1&region=us",
            "portrait360": null
          }
        },
        "stats": {
          "plays": 24,
          "likes": 0,
          "comments": 0
        }
      }
    ],
    "page": {
      "page": 1,
      "perPage": 25,
      "total": 4723,
      "hasMore": true,
      "nextCursor": "eyJwIjoyLCJmIjoiMjYwM2ZmNDhmZDExNjQwMjk1ZTcifQ"
    }
  },
  "meta": {
    "requestId": "req_8d3e894b-5c69-407a-bf2a-e14cf4c15dfe",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.vimeo.listGroupVideos({
  group: "creativeapps",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/vimeo/groups/creativeapps/videos",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

### cURL

```bash
curl "https://api.socialfetch.dev/v1/vimeo/groups/creativeapps/videos" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/vimeo/groups/creativeapps/videos",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/vimeo/groups/value/videos");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```