Distributions

List distributions

Retrieve the distributions accessible to the authenticated account, newest first. Optionally filter by study ID or distribution type. Returns one page of limit distributions (default 50); pass next_cursor back as cursor to read the next page.

get/api/v1/distributions

Request

Base URL
https://app.voicepanel.com
URL
https://app.voicepanel.com/api/v1/distributions
Auth
HTTP bearer

Query parameters

studyIdstring

Example:stdy_Qm3vR8tLp2XnWz

Filter distributions by study ID

Example:link

Filter by distribution type

limitinteger

Page size (1-200). Defaults to 50. When has_more is true, pass next_cursor back as cursor to read the next page.

cursorstring

Opaque cursor from a previous page's next_cursor. Returns the rows after that position.

Response

Successful response

has_moreboolean required

True when rows exist after the last one in data

next_cursorstring nullable required

Pass back as cursor to read the next page

Example response

{
  "data": [
    {
      "id": "dst_7C1hPliVteu3n4",
      "url": "https://app.voicepanel.co/d/7C1hPliVteu3n4",
      "study_id": "stdy_Qm3vR8tLp2XnWz",
      "name": "March newsletter link",
      "description": "Shared with newsletter subscribers in March.",
      "type": "link",
      "status": "published",
      "config": {},
      "incentive": {
        "type": "gift_card",
        "amount": 10,
        "title": "$10 gift card",
        "description": "Sent by email after you complete the interview."
      },
      "quota_limit": 100,
      "quota_frequency": "lifetime",
      "quota_usage": 42,
      "screener_questions": [
        {
          "text": "Have you ordered grocery delivery in the last 3 months?",
          "type": "radio",
          "isRequired": true,
          "options": [
            {
              "text": "Yes",
              "qualification": "qualify"
            },
            {
              "text": "No",
              "qualification": "disqualify"
            }
          ]
        }
      ],
      "default_response_language": "en",
      "automatic_invites": true,
      "complete_redirect_url": "https://example.com/thanks?rid={{response_id}}",
      "seq_num": 1,
      "published_at": "2026-03-02T15:12:00.000Z",
      "last_completed_at": "2026-03-09T18:45:00.000Z",
      "created_by": "0f1b3c6e-9d2a-4b7c-8e5f-2a1d4c6b8e90",
      "created_at": "2026-03-02T15:00:00.000Z",
      "updated_at": "2026-03-09T18:45:00.000Z",
      "pretranslations": [
        {
          "locale": "es"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.