forms:query

Description: Retrieve a list of forms and their schema.

---

Request Schema

{
  "payload": {
    "type": "forms:query",
    "q": {
      "per_page": 10,
      "page": 1,
      "name_cont": "form"
    }
  },
  "signature": "payload_ed25519_hex_signature",
  "source_public_key": "your_client_public_key"
}

Request Attributes

• See global request attributes
• See search request attributes, and:
• payload.q.name_cont - String - Records contains a given string in name
• payload.q.survey_contexts_kind_eq - String - Records contains a given string in one of their contexts, for example for forms related to people, survey_contexts_kind_eq=person

Response Schema

{
  "source_public_key": "community_public_key",
  "source_site": {
    "protocol": "http",
    "fqdn": "arkipel.localhost:3000"
  },
  "created_at": "2025-11-13T20:52:49Z",
  "signature": "8b6392d5550605bd6ccddf9c21ebec470de4b44e4b4deb746076e37ab61c5346e07e7c7c7cebb5bbee41cdd92a476bcd3f02373d146ec165b31c31fc31c9ce0d",
  "payload": {
    "q": {
        "per_page": 10,
        "page": 1,
        "total": 10
    },
    "resources": [
        { "id": 1, "name": "Form 1", ... }, // see payload specs for form:query
        { ... },
        { "id": 10, "name": "Form 10", ... }
    ],
    "type": "forms:query"
  }
}