> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adspo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get groups

> Returns your groups, by name. A group is a named list of brands you follow, such as your competitors or a client's market, and each comes with its brands. In a team, this includes the team's groups.


> [!NOTE]
>
> **Credits:** 1 credit per request.


## OpenAPI

````yaml GET /v1/groups
openapi: 3.1.0
info:
  title: Adspo API
  version: 1.0.0
  description: >
    The Adspo API gives you programmatic access to ad creative data across
    brands.


    ## Authentication


    All endpoints require an API key passed in the `x-api-key` header.


    ```

    x-api-key: YOUR_API_KEY

    ```


    ## Rate limits


    - **120 requests per minute** per key. Exceeding this returns `429` with a
    `Retry-After` header. Every response carries `RateLimit-Limit`,
    `RateLimit-Remaining` and `RateLimit-Reset` headers.

    - **Credits per billing period** vary by plan. Each request costs 1 credit
    (`/v1/usage` is free). Exceeding your quota returns `429` with `resets_at`
    indicating when it resets.

    - A key whose account has no active subscription gets `403`.

    - **Changes** have their own per-person limits, across all their keys and
    connections: saving creatives and adding them to boards, 30 a minute;
    creating boards, 10 a minute; following brands and adding them to groups, 30
    a minute. Exceeding these returns `429` with a `Retry-After` header. Each
    costs 1 credit only when it changes something; anything already there is
    free.
servers:
  - url: https://api.adspo.co
    description: Production
security:
  - apiKey: []
paths:
  /v1/groups:
    get:
      summary: Get groups
      description: >
        Returns your groups, by name. A group is a named list of brands you
        follow, such as your competitors or a client's market, and each comes
        with its brands. In a team, this includes the team's groups.
      operationId: getGroups
      parameters:
        - $ref: '#/components/parameters/workspace_id'
      responses:
        '200':
          description: Groups.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
              example:
                count: 1
                groups:
                  - group_id: 5b9f3c2e-8d41-4e6a-9a57-2f1c0d7e8b44
                    name: Competitors
                    description: null
                    workspace_id: null
                    brand_count: 2
                    brands:
                      - brand_id: '333513037263180'
                        name: Adidas
                        domain: adidas.com
                        image_uri: https://r2.adspo.co/pages/333513037263180.jpg
                      - brand_id: '15087023444'
                        name: Nike
                        domain: nike.com
                        image_uri: https://r2.adspo.co/pages/15087023444.jpg
                    created_at: '2026-03-01T10:00:00Z'
                    updated_at: '2026-04-15T14:22:00Z'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Workspace not found, or not one of yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    workspace_id:
      name: workspace_id
      in: query
      description: >-
        Only this workspace (from [Get
        workspaces](/api-reference/get-workspaces)). Pass `default` for the
        default workspace. Omit for all of your workspaces.
      schema:
        type: string
      example: 0133afa6-5326-4a70-aa10-c9358eb6de04
  schemas:
    Group:
      type: object
      properties:
        group_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
          nullable: true
        workspace_id:
          type: string
          format: uuid
          nullable: true
          description: The workspace the group is in. null for the default workspace.
        brand_count:
          type: integer
          description: Number of brands in the group.
        brands:
          type: array
          description: The group's brands, by name.
          items:
            type: object
            properties:
              brand_id:
                type: string
                description: Facebook Ad Library page ID.
              name:
                type: string
              domain:
                type: string
                nullable: true
              image_uri:
                type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Forbidden:
      description: >
        The account behind the key has no active subscription (`No active
        subscription`), or a team key's subscription can't be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: No active subscription
    TooManyRequests:
      description: >
        Either the per-minute rate limit or the credit quota was exceeded. The
        two look different:


        - **Rate limit** (120 requests per minute): the response has a
        `Retry-After` header with the seconds to wait.

        - **Quota** (credits per billing period): the body includes `limit` and
        `resets_at`. Retrying won't help until then.
      headers:
        Retry-After:
          description: >-
            Seconds until the rate limit window resets. Only sent when the rate
            limit was hit.
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              limit:
                type: integer
                description: >-
                  Credits in the billing period. Only present when the quota was
                  exceeded.
              resets_at:
                type: string
                format: date-time
                description: >-
                  When the quota resets. Only present when the quota was
                  exceeded.
          examples:
            rate_limit:
              summary: Rate limit
              value:
                error: Rate limit exceeded. Maximum 120 requests per minute.
            quota:
              summary: Quota
              value:
                error: Quota exceeded
                limit: 10000
                resets_at: '2026-06-04T22:38:10Z'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Adspo API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.