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

# List

> Your agencies.



## OpenAPI

````yaml GET /agencies
openapi: 3.0.3
info:
  title: OnlyTraffic Studio API
  version: 1.0.0
  description: >-
    External API for OnlyTraffic Studio. Manage and retrieve data about your
    subscribers, CPL orders, and CPC orders.
servers:
  - url: https://studio-api.onlytraffic.com/api/external/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: API key holder's wallet, profile, and aggregate state.
  - name: Accounts
    description: OnlyFans accounts attached to the API key holder.
  - name: Agencies
    description: Agency CRUD and image management. All edits stage in moderation.
  - name: CPL
    description: >-
      Cost-per-lead orders: place, list, cancel, manage settings, browse partner
      offers.
  - name: CPC
    description: Cost-per-click orders and creative management.
  - name: RevShare
    description: Revenue-share campaigns and invoices.
  - name: Swaps
    description: Two-sided traffic swap orders and offers.
  - name: Subscribers
    description: Per-fan delivery feed (cursor-paginated).
  - name: Transactions
    description: Per-transaction OF revenue feed (cursor-paginated).
paths:
  /agencies:
    get:
      tags:
        - Agencies
      summary: List
      description: Your agencies.
      operationId: getAgencies
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: uuid
          in: query
          schema:
            type: string
            format: uuid
          description: Filter to one agency by UUID.
        - name: slug
          in: query
          schema:
            type: string
            maxLength: 128
          description: Filter to one agency by slug.
        - name: search
          in: query
          schema:
            type: string
            maxLength: 128
          description: Substring match across `name`, `slug`, and `code`.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - moderation
              - disabled
        - name: topagencies_publish
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '1'
              - '0'
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - created_at_desc
              - created_at_asc
              - updated_at_desc
              - updated_at_asc
              - name_asc
              - name_desc
            default: created_at_desc
          description: |-
            Sort order.
            - `created_at_desc`: newest agencies first (default).
            - `created_at_asc`: oldest agencies first.
            - `updated_at_desc`: most recently updated first.
            - `updated_at_asc`: least recently updated first.
            - `name_asc`: by name A→Z.
            - `name_desc`: by name Z→A.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Agency'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: >-
            Server error. Body always reads `{success:false,
            error:"server_error", message:"Server error"}` (no internal details
            leak).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number, 1-indexed.
      example: 1
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      description: Items per page. Default 50, max 100.
      example: 50
  schemas:
    Agency:
      type: object
      description: Agency record owned by the API key holder.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Stable public identifier of the agency. Used as the path parameter
            on `/agencies/{uuid}`. Linked OF accounts reference this value via
            their `agency_id` field.
          example: 8c1e3b80-7aef-4d26-9ed9-3a1f0b2c91ab
        name:
          type: string
          example: Bright Studio
        slug:
          type: string
          example: bright-studio
        code:
          type: string
          description: >-
            Agency code, 3 to 6 uppercase letters. Set once at creation and
            immutable afterwards.
          example: BST
        status:
          type: string
          enum:
            - moderation
            - active
            - disabled
          example: active
        description:
          type: string
          nullable: true
        website:
          type: string
          nullable: true
          format: uri
        tg_contact:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
          format: email
        email_published:
          type: boolean
        model_commission:
          type: number
          format: float
          nullable: true
        model_commission_max:
          type: number
          format: float
          nullable: true
        model_commission_custom:
          type: string
          nullable: true
        model_requirements:
          type: string
          nullable: true
        platforms:
          type: array
          items:
            type: string
            enum:
              - onlyfans
              - fansly
        offered_services:
          type: array
          items:
            type: string
            enum:
              - growth_marketing
              - chatting_management
              - social_media_management
              - content_support
              - branding_pr
              - dmca_protection
              - legal_support
              - coaching_consulting
        founded:
          type: string
          format: date
          nullable: true
        service_model:
          type: string
          enum:
            - not_specified
            - full_service
            - boutique
            - specialized
            - coaching
          nullable: true
          description: >-
            Self-declared service model. Read-only labels are translated
            client-side.
        avatar_url:
          type: string
          format: uri
          nullable: true
          description: CDN URL of the agency avatar.
        header_url:
          type: string
          format: uri
          nullable: true
          description: CDN URL of the agency header.
        models_count_size:
          type: string
          enum:
            - not_specified
            - '0_10'
            - '10_50'
            - '50_100'
            - 100_plus
          description: Self-declared size bucket.
        models_countries:
          type: array
          items:
            type: string
            minLength: 2
            maxLength: 2
          nullable: true
          description: >-
            Array of ISO 3166-1 alpha-2 codes; `null` = worldwide / not
            specified.
        topagencies_publish:
          type: boolean
        models_count_bound:
          type: integer
          description: Live count of OnlyFans accounts attached to this agency.
          example: 12
        created_at:
          type: string
          format: date-time
        created_at_ts:
          type: integer
        updated_at:
          type: string
          format: date-time
        updated_at_ts:
          type: integer
    Pagination:
      type: object
      description: >-
        Page-based pagination, returned by every list endpoint that isn't a
        cursor feed.
      properties:
        page:
          type: integer
          description: Current page number (1-indexed).
          example: 1
        page_size:
          type: integer
          description: Number of items per page. Default 50, max 100.
          example: 50
        total:
          type: integer
          description: Total number of records matching the filters.
          example: 150
        total_pages:
          type: integer
          description: Total pages available.
          example: 3
        has_next:
          type: boolean
          description: >-
            `true` when `page < total_pages` (i.e. there is at least one more
            page to fetch).
          example: true
    ErrorResponse:
      type: object
      description: Standard error envelope for all 4xx/5xx responses.
      required:
        - success
        - error
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Always false on error responses.
        error:
          type: string
          description: Stable snake_case machine-readable error code. Branch on this.
          example: validation_failed
        message:
          type: string
          description: >-
            Human-friendly text. For 5xx this is always the literal `Server
            error`. For 4xx an actionable validation/auth message is returned.
        details:
          type: object
          nullable: true
          description: >-
            Optional per-field diagnostic information. On 422 carries `{<field>:
            ["error_code", ...]}`. On 402 (`insufficient_balance`) carries
            `{required, current}`. On 426 (`unpaid_invoices`) carries `{count,
            total, oldest_date_ts}`. Absent on most other errors.
          additionalProperties: true
        retry_after:
          type: integer
          nullable: true
          description: >-
            Seconds until the next request will succeed. Present only on 429
            responses (rate limit). Mirrors the `Retry-After` HTTP header.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the Studio Dashboard

````