---
updatedAt: 2026-05-22T05:45:34.000Z
agentTools:
  projectIndex: https://audata.readme.io/llms.txt
---

# List lists

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Promo API",
    "description": "Comprehensive API for accessing Promo resources.",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://promo.audata.io/api/v2",
      "description": "Production Server"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Campaign": {
        "type": "object",
        "description": "Represents a promotional campaign, which can have multiple deliverables and be associated with a client.",
        "required": [
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "budget": {
            "type": "number",
            "format": "float"
          },
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "end_date": {
            "type": "string",
            "format": "date"
          },
          "finance_data": {
            "type": "object",
            "additionalProperties": true
          },
          "client": {
            "$ref": "#/components/schemas/Client"
          },
          "owner_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the owner (user who created the campaign)"
          },
          "station_uuids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "readOnly": true,
            "description": "UUIDs of the associated stations"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "Client": {
        "type": "object",
        "description": "Represents a client (brand or advertiser) associated with campaigns and deliverables.",
        "required": [
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "owner_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the owner (user who created the client)"
          },
          "station_uuids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "readOnly": true,
            "description": "UUIDs of the associated stations"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "List": {
        "type": "object",
        "description": "Represents a list of listeners.",
        "required": [
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "allow_duplicates": {
            "type": "boolean"
          },
          "allow_same_household": {
            "type": "boolean"
          },
          "listener_notes": {
            "type": "string"
          },
          "campaign": {
            "$ref": "#/components/schemas/Campaign"
          },
          "station_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the associated station"
          },
          "archived_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/lists": {
      "get": {
        "summary": "List lists",
        "tags": [
          "Lists"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "created_date_from",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "in": "query",
            "name": "created_date_until",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "in": "query",
            "name": "active",
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            },
            "description": "Use 'true' for lists that are not archived, 'false' for archived lists. Omit to return all."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/List"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid date format",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  }
}
```