---
agentTools:
  projectIndex: https://docs.developer.yelp.com/llms.txt
---

# Program List All

Returns the entire list of past, current and future advertising programs under a given payment account with info for each program (status, start/end date).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Partner Support",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://partner-api.yelp.com"
    }
  ],
  "security": [
    {
      "basic": []
    }
  ],
  "components": {
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "paths": {
    "/programs/v1": {
      "get": {
        "tags": [
          "Partner Support"
        ],
        "summary": "Program List All",
        "description": "Returns the entire list of past, current and future advertising programs under a given payment account with info for each program (status, start/end date).\n",
        "operationId": "get_program_list_all",
        "parameters": [
          {
            "name": "offset",
            "description": "Pagination offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "limit",
            "description": "Pagination limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 20,
              "minimum": 1,
              "maximum": 40
            }
          },
          {
            "name": "program_status",
            "description": "Filter by a specific program status",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "default": "CURRENT",
              "enum": [
                "PAST",
                "PAUSED",
                "CURRENT",
                "FUTURE",
                "ALL"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully fetched a list of advertising programs.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "total": 2,
                      "program_status": "CURRENT",
                      "offset": 0,
                      "limit": 20,
                      "payment_programs": [
                        {
                          "program_type": "CPC",
                          "end_date": "9999-12-31",
                          "program_status": "ACTIVE",
                          "available_features": [
                            "LINK_TRACKING",
                            "NEGATIVE_KEYWORD_TARGETING",
                            "STRICT_CATEGORY_TARGETING",
                            "AD_SCHEDULING",
                            "CUSTOM_LOCATION_TARGETING",
                            "AD_GOAL",
                            "CALL_TRACKING"
                          ],
                          "program_id": "hTF5yeJ8OUQim6AXrz8w",
                          "active_features": [
                            "LINK_TRACKING",
                            "AD_GOAL"
                          ],
                          "program_metrics": {
                            "currency": "USD",
                            "ad_cost": 0,
                            "billed_clicks": 0,
                            "is_autobid": false,
                            "billed_impressions": 0,
                            "budget": 10000,
                            "fee_period": "Not Billed",
                            "max_bid": 800
                          },
                          "program_pause_status": "NOT_PAUSED",
                          "businesses": [
                            {
                              "yelp_business_id": "nR5LcSr2yPjpHKc_o2zQ",
                              "partner_business_id": null
                            }
                          ],
                          "start_date": "2015-12-10"
                        },
                        {
                          "program_type": "CPC",
                          "end_date": "9999-12-31",
                          "program_status": "ACTIVE",
                          "available_features": [
                            "LINK_TRACKING",
                            "NEGATIVE_KEYWORD_TARGETING",
                            "STRICT_CATEGORY_TARGETING"
                          ],
                          "program_id": "ePVAp5-9zdyw4jvSaccg\"",
                          "active_features": [
                            "STRICT_CATEGORY_TARGETING"
                          ],
                          "program_metrics": {
                            "currency": "USD",
                            "ad_cost": 0,
                            "billed_clicks": 0,
                            "is_autobid": false,
                            "billed_impressions": 0,
                            "budget": 7500,
                            "fee_period": "Not Billed",
                            "max_bid\"": 1000
                          },
                          "businesses": [
                            {
                              "yelp_business_id": "nR5LcSr2y2wPHKc_o2zQ",
                              "partner_business_id": null
                            }
                          ],
                          "start_date": "2015-12-10"
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "program_status": {
                      "type": "string"
                    },
                    "total": {
                      "type": "integer"
                    },
                    "offset": {
                      "type": "integer"
                    },
                    "limit": {
                      "type": "integer"
                    },
                    "payment_programs": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "program_type": {
                            "type": "string"
                          },
                          "program_id": {
                            "type": "string"
                          },
                          "start_date": {
                            "type": "string"
                          },
                          "end_date": {
                            "type": "string"
                          },
                          "program_status": {
                            "type": "string"
                          },
                          "program_pause_status": {
                            "type": "string"
                          },
                          "available_features": {
                            "type": "array",
                            "items": "type. string"
                          },
                          "active_features": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "program_metrics": {
                            "type": "object",
                            "properties": {
                              "currency": {
                                "type": "string"
                              },
                              "ad_cost": {
                                "type": "integer"
                              },
                              "billed_clicks": {
                                "type": "integer"
                              },
                              "is_autobid": {
                                "type": "boolean"
                              },
                              "billed_impressions": {
                                "type": "integer"
                              },
                              "budget": {
                                "type": "integer"
                              },
                              "fee_period": {
                                "type": "string"
                              },
                              "max_bid": {
                                "type": "integer"
                              }
                            }
                          },
                          "businesses": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "yelp_business_id": {
                                  "type": "string"
                                },
                                "partner_business_id": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": []
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false,
    "samples-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 189,
      "2": 123,
      "3": 86,
      "4": 29,
      "5": 129,
      "6": 248,
      "7": 0,
      "8": 111,
      "9": 108,
      "10": 179,
      "11": 147
    }
  }
}
```