---
updatedAt: 2026-04-23T05:40:30.000Z
---

# Lists pages

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "API V1",
    "version": "v1"
  },
  "paths": {
    "/pages": {
      "get": {
        "summary": "Lists pages",
        "tags": [
          "Pages"
        ],
        "parameters": [
          {
            "name": "_limit",
            "in": "query",
            "description": "Limits the number of items returned. Default is 20, maximum is 100.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 20
            }
          },
          {
            "name": "_offset",
            "in": "query",
            "description": "Number of items to skip before starting to return the results.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "_since",
            "in": "query",
            "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "include_action_counts",
            "in": "query",
            "description": "When true, each page includes action_count (total submissions) and action_goal (the next milestone the public progress bar would display for that count). Off by default.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "pages listed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "type": {
                            "type": "string",
                            "nullable": true,
                            "description": "Page type, for example ActionPage::GenericForm, ActionPage::Petition, or ActionPage::EventCampaign."
                          },
                          "url_slug": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string",
                            "description": "Internal page name, unique per website."
                          },
                          "title": {
                            "type": "string",
                            "nullable": true,
                            "description": "Headline on the page, in the organization default language."
                          },
                          "website_id": {
                            "type": "integer",
                            "nullable": true
                          },
                          "is_published": {
                            "type": "boolean"
                          },
                          "full_url": {
                            "type": "string",
                            "nullable": true,
                            "description": "Public URL of the page."
                          },
                          "scope_id": {
                            "type": "integer",
                            "nullable": true
                          },
                          "scope_type": {
                            "type": "string",
                            "nullable": true,
                            "enum": [
                              "Organization",
                              "Chapter",
                              null
                            ]
                          },
                          "supported_languages": {
                            "type": "array",
                            "nullable": true,
                            "items": {
                              "type": "string"
                            }
                          },
                          "follow_up": {
                            "type": "object",
                            "nullable": true,
                            "description": "What happens after a submission."
                          },
                          "confirmations": {
                            "type": "object",
                            "nullable": true,
                            "description": "Confirmation messages sent after a submission."
                          },
                          "admin_notifications": {
                            "type": "object",
                            "nullable": true,
                            "description": "Admin notifications sent after a submission."
                          },
                          "requires_user": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "always_hide_primary_nav": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "always_hide_footer": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "allow_multiple_responses": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "form": {
                            "type": "array",
                            "nullable": true,
                            "items": {
                              "type": "object"
                            },
                            "description": "The raw form builder components. For generic form pages, fields gives the same form in the shape that POST and PATCH accept."
                          },
                          "fields": {
                            "type": "array",
                            "nullable": true,
                            "items": {
                              "type": "object",
                              "description": "A question or contact field has type and name. A custom property field has property instead. Send this object back unchanged in PATCH to keep the field as it is.",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "description": "Absent on a custom property field."
                                },
                                "name": {
                                  "type": "string",
                                  "description": "Key for the answer in submissions. Absent on a custom property field."
                                },
                                "property": {
                                  "type": "string",
                                  "description": "internal_name of the custom property. The answer saves onto the person."
                                },
                                "label": {
                                  "type": "object",
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "description": "{ language_code: text }"
                                },
                                "required": {
                                  "type": "boolean"
                                },
                                "placeholder": {
                                  "type": "object",
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "description": "{ language_code: text }"
                                },
                                "options": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "label": {
                                        "type": "object",
                                        "additionalProperties": {
                                          "type": "string"
                                        },
                                        "description": "{ language_code: text }"
                                      },
                                      "value": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                },
                                "options_from_property": {
                                  "type": "boolean",
                                  "description": "true when the options follow a custom property; change them on the property."
                                }
                              }
                            },
                            "description": "Generic form pages only. Null on other page types and on forms with parts the API cannot describe (HTML blocks, subforms, conditional fields, builder only field types)."
                          },
                          "description": {
                            "type": "string",
                            "nullable": true,
                            "description": "HTML above the form, in the organization default language."
                          },
                          "campaign_tags": {
                            "type": "array",
                            "nullable": true,
                            "items": {
                              "type": "string"
                            }
                          },
                          "created_at": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "admin_url": {
                            "type": "string",
                            "nullable": true,
                            "description": "The page in the dashboard."
                          },
                          "action_count": {
                            "type": "integer",
                            "description": "With include_action_counts=true only. Total submissions."
                          },
                          "action_goal": {
                            "type": "integer",
                            "description": "With include_action_counts=true only. The next milestone the public progress bar shows."
                          }
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "total_count": {
                          "type": "integer"
                        },
                        "limit": {
                          "type": "integer"
                        },
                        "offset": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.solidarity.tech/v1",
      "variables": {
        "defaultHost": {
          "default": "api.solidarity.tech/v1"
        }
      }
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```