distributions:query

Description: Retrieve a list of distributions.

Request Schema

{
  "payload": {
    "type": "distributions:query",
    "q": {
      "per_page": 10,
      "page": 1,
      "created_at_gteq": "2026-01-01",
      "created_at_lteq": "2026-01-31",
      "invoice_number_cont": "INV-2026",
      "invoice_date_gteq": "2026-01-01",
      "invoice_date_lteq": "2026-01-31"
    }
  },
  "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.created_at_gteq - Date (%Y-%m-%d) - Records created after and including given date
  • payload.q.created_at_lteq - Date (%Y-%m-%d) - Records created before and including given given date
  • payload.q.invoice_number_cont - String - Invoice number contains (partial match)
  • payload.q.invoice_number_eq - String - Invoice number exact match
  • payload.q.invoice_date_gteq - Date (%Y-%m-%d) - Invoice date after and including given date
  • payload.q.invoice_date_lteq - Date (%Y-%m-%d) - Invoice date before and including given date
  • payload.q.invoice_date_eq - Date (%Y-%m-%d) - Invoice date exact match

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": [
      { ... }
    ],
    "type": "distributions:query"
  }
}

Back to top

Welcome to the Arkipel DevKit! This documentation will guide you through everything you need to build clients for Arkipel communities.

Contact: devkit@arkipel.co | Page URLs

Copyright © 2026 Arkipel. Distributed under an MIT license.