form:query

Description: Retrieve a single form by ID.

Request Schema

{
  "payload": {
    "type": "form:query",
    "id": "FORM_ID_TO_FIND"
  },
  "signature": "payload_ed25519_hex_signature",
  "source_public_key": "your_client_public_key"
}

Request Attributes

See global request attributes

Find attribute:

payload.id - Integer - The form’s internal Arkipel ID

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": {
    "resource": {
      "id": 1,
      "name": "Form 1",
      "locale": "en",
      "contexts": [
        "person"
      ],
      "inputs": [{
        "key": "typeDeDistribution",
        "values": [
          {
            "label": "Personnes",
            "value": "personnes",
            "shortcut": ""
          },
          {
            "label": "Ménages",
            "value": "menages",
            "shortcut": ""
          }
        ],
        "type": "radio",
        "label": "Type de distribution"
      },
      {
        "key": "femme",
        "type": "checkbox",
        "label": "Femme"
      }
      ],
      "created_at": "2024-02-19T11:46:29-05:00",
      "updated_at": "2024-03-11T13:41:32-04:00"
    },
    "type": "form:query"
  }
}

Response Attributes

payload.resource.id - Integer - The form’s internal Arkipel ID
payload.resource.name - String - The form’s name
payload.resource.contexts - Array[String] - What subject’s can that form be attached to through an upsert message, for example: person context can be used in people:upsert or household context can be used in households:upsert
payload.resource.inputs - Array[key, values , type , label] - The form’s collection of potential values that can be filled, see the message form:fill for more details