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

# List deliveries

# 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"
            }
          }
        }
      },
      "Attachment": {
        "type": "object",
        "description": "Represents a file attachment.",
        "required": [
          "file_url"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "file_file_name": {
            "type": "string",
            "description": "Original filename of the uploaded file",
            "readOnly": true
          },
          "file_content_type": {
            "type": "string",
            "readOnly": true,
            "description": "MIME type of the uploaded file"
          },
          "file_file_size": {
            "type": "integer",
            "readOnly": true,
            "description": "Size of the uploaded file in bytes"
          },
          "file_url": {
            "type": "string",
            "description": "URL of the uploaded file"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "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
          }
        }
      },
      "Contest": {
        "type": "object",
        "readOnly": true,
        "description": "Represents a contest deliverable, which awards prizes to listeners.",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "prize_type": {
            "type": "string"
          },
          "fixed_cash_amount": {
            "type": "number",
            "format": "float"
          },
          "prize_quantity": {
            "type": "integer"
          },
          "station_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the associated station"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "Delivery": {
        "type": "object",
        "description": "Represents the delivery of a promotion (liner, live read, attachment, or contest) to a station on a specific date.",
        "required": [
          "deliverable_type",
          "deliverable_uuid",
          "delivered_at"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "deliverable": {
            "$ref": "#/components/schemas/Deliverable"
          },
          "delivered_at": {
            "type": "string",
            "format": "date-time"
          },
          "airchecked": {
            "type": "boolean"
          },
          "campaign": {
            "$ref": "#/components/schemas/Campaign"
          },
          "user_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the user associated with the delivery"
          },
          "presenter_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the presenter associated with the delivery"
          },
          "schedule_assignment": {
            "$ref": "#/components/schemas/ScheduleAssignment"
          },
          "station_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the associated station"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "Deliverable": {
        "description": "The promotion this delivery is attached to.",
        "discriminator": {
          "propertyName": "deliverable_type",
          "mapping": {
            "Liner": "#/components/schemas/Liner",
            "LiveRead": "#/components/schemas/LiveRead",
            "Attachment": "#/components/schemas/Attachment",
            "Contest": "#/components/schemas/Contest"
          }
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/Liner"
          },
          {
            "$ref": "#/components/schemas/LiveRead"
          },
          {
            "$ref": "#/components/schemas/Attachment"
          },
          {
            "$ref": "#/components/schemas/Contest"
          }
        ]
      },
      "Liner": {
        "type": "object",
        "description": "Represents a liner deliverable, which is a promotional message that airs on the station.",
        "required": [
          "name",
          "content"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "end_date": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string"
          },
          "campaign": {
            "$ref": "#/components/schemas/Campaign"
          },
          "station_uuids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "readOnly": true,
            "description": "UUIDs of the associated stations"
          },
          "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
          }
        }
      },
      "LiveRead": {
        "type": "object",
        "description": "Represents a live read deliverable, which is a promotional message that a presenter reads live on air.",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "start_date": {
            "type": "string",
            "format": "date"
          },
          "end_date": {
            "type": "string",
            "format": "date"
          },
          "status": {
            "type": "string"
          },
          "campaign": {
            "$ref": "#/components/schemas/Campaign"
          },
          "client": {
            "$ref": "#/components/schemas/Client"
          },
          "station_uuids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "readOnly": true,
            "description": "UUIDs of the associated stations"
          },
          "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
          }
        }
      },
      "ScheduleAssignment": {
        "type": "object",
        "readOnly": true,
        "description": "Represents the assignment of a delivery to a specific show and time slot in the station's schedule. This allows for tracking when a promotion is scheduled to air and associating it with the relevant show and time slot.",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "deliveries": {
            "type": "string",
            "description": "Delivery progress in the format (delivered quantity/assigned quantity)"
          },
          "deliverable_type": {
            "type": "string",
            "description": "Type of item assigned to the schedule slot"
          },
          "colour": {
            "type": "string",
            "nullable": true,
            "description": "Scheduler colour configured for the station for this assignment type (contest, liner, attachment or live_read)"
          },
          "campaign_uuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "UUID of the associated campaign"
          },
          "campaign_name": {
            "type": "string",
            "nullable": true,
            "description": "Name of the associated campaign"
          },
          "contest_type": {
            "type": "string",
            "nullable": true,
            "description": "Prize type of the contest. Only set when deliverable_type is Contest"
          },
          "deliverable_uuid": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "UUID of the assigned deliverable"
          },
          "show_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the associated show"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "station_uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "UUID of the associated station"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/deliveries": {
      "get": {
        "summary": "List deliveries",
        "tags": [
          "Deliveries"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "campaign_id",
            "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"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Delivery"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid date format",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  }
}
```