{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-Docs/Get-started/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Quickstart: Distribution Manager (V3)"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quickstart-distribution-manager-v3","__idx":0},"children":["Quickstart: Distribution Manager (V3)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page assumes you have a valid access token. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/get-started/api-basics"},"children":["API Basics"]}," for authentication."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-list-your-distributions","__idx":1},"children":["1. List your distributions"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v3/distribution-manager/distributions\n"},"children":[]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request GET \\\n  --url '[Your API Base URL]/v3/distribution-manager/distributions?pageNumber=1&pageSize=20' \\\n  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\n\nurl = \"[Your API Base URL]/v3/distribution-manager/distributions\"\nparams = {\"pageNumber\": 1, \"pageSize\": 20}\nheaders = {\"Authorization\": \"Bearer YOUR_ACCESS_TOKEN\"}\n\nresponse = requests.get(url, params=params, headers=headers)\nprint(response.json())\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Node","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const response = await fetch(\n  '[Your API Base URL]/v3/distribution-manager/distributions?pageNumber=1&pageSize=20',\n  {\n    method: 'GET',\n    headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }\n  }\n);\nconst data = await response.json();\nconsole.log(data);\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Succesful response example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"pageNumber\": 1,\n  \"pageSize\": 20,\n  \"totalPages\": 5,\n  \"totalItems\": 98,\n  \"data\": [\n    {\n      \"distribution\": {\n        \"id\": \"1a2b3c4d-e5f6-7890-1234-567890abcdef\",\n        \"name\": \"Q3 Settlement\",\n        \"externalId\": \"settlement-q3-2024\",\n        \"welcomeHeadline\": \"Your payment is ready\",\n        \"distributionDescription\": \"Q3 settlement for eligible beneficiaries\",\n        \"distributionManager\": null,\n        \"welcomeText\": \"Please select a payout method to receive your funds.\",\n        \"iconUrl\": \"https://cdn.talli.ai/distributions/q3-settlement/icon.png\",\n        \"payoutMethods\": [\n          {\n            \"payoutMethodId\": \"3c4d5e6f-a7b8-9012-3456-789012cdef01\",\n            \"isDisabled\": false,\n            \"disableReason\": null\n          }\n        ],\n        \"expiryDate\": \"2028-12-31\",\n        \"displayEndDate\": \"2028-06-30\",\n        \"creationDate\": \"2024-01-15\",\n        \"emailTemplates\": {\n          \"InitiateEmail\": \"5e6f7a8b-c9d0-1234-5678-901234ef0123\"\n        },\n        \"automaticReminders\": \"None\",\n        \"otpThresholdAmount\": null,\n        \"fromEmail\": null,\n        \"bankAccountId\": \"9z8y7x6w-v5u4-t3s2-r1q0-p9o8n7m6l5k4\"\n      },\n      \"details\": null\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated list of your dsitributions."," ","Copy the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distribution.id"]}," of the distribution you want to inspect."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-get-a-single-distribution","__idx":2},"children":["2. Get a single distribution"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR_DISTRIBUTION_ID"]}," in the URL with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," you copied in step 1."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v3/distribution-manager/distributions/{id}\n"},"children":[]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request GET \\\n  --url '[Your API Base URL]/v3/distribution-manager/distributions/YOUR_DISTRIBUTION_ID' \\\n  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\n\nurl = \"[Your API Base URL]/v3/distribution-manager/distributions/YOUR_DISTRIBUTION_ID\"\nheaders = {\"Authorization\": \"Bearer YOUR_ACCESS_TOKEN\"}\n\nresponse = requests.get(url, headers=headers)\nprint(response.json())\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Node","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const response = await fetch(\n  '[Your API Base URL]/v3/distribution-manager/distributions/YOUR_DISTRIBUTION_ID',\n  {\n    method: 'GET',\n    headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }\n  }\n);\nconst data = await response.json();\nconsole.log(data);\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Succesful response example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"1a2b3c4d-e5f6-7890-1234-567890abcdef\",\n  \"name\": \"Q3 Settlement\",\n  \"externalId\": \"settlement-q3-2024\",\n  \"welcomeHeadline\": \"Your payment is ready\",\n  \"distributionDescription\": \"Q3 settlement for eligible beneficiaries\",\n  \"distributionManager\": null,\n  \"welcomeText\": \"Please select a payout method to receive your funds.\",\n  \"iconUrl\": \"https://cdn.talli.ai/distributions/q3-settlement/icon.png\",\n  \"payoutMethods\": [\n    {\n      \"payoutMethodId\": \"3c4d5e6f-a7b8-9012-3456-789012cdef01\",\n      \"isDisabled\": false,\n      \"disableReason\": null\n    }\n  ],\n  \"expiryDate\": \"2028-12-31\",\n  \"displayEndDate\": \"2028-06-30\",\n  \"creationDate\": \"2024-01-15\",\n  \"emailTemplates\": {\n    \"InitiateEmail\": \"5e6f7a8b-c9d0-1234-5678-901234ef0123\"\n  },\n  \"automaticReminders\": \"None\",\n  \"otpThresholdAmount\": null,\n  \"fromEmail\": null,\n  \"bankAccountId\": \"9z8y7x6w-v5u4-t3s2-r1q0-p9o8n7m6l5k4\"\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the full distribution object, payout methods, expiry date, bank account, and configuration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-download-a-distribution-report","__idx":3},"children":["3. Download a distribution report"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v3/distribution-manager/reports/distributions/{id}/basic\n"},"children":[]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request GET \\\n  --url '[Your API Base URL]/v3/distribution-manager/reports/distributions/YOUR_DISTRIBUTION_ID/basic?pageNumber=1&pageSize=1000' \\\n  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \\\n  --header 'Accept: text/csv' \\\n  --output distribution_report.csv\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\n\nurl = \"[Your API Base URL]/v3/distribution-manager/reports/distributions/YOUR_DISTRIBUTION_ID/basic\"\nparams = {\"pageNumber\": 1, \"pageSize\": 1000}\nheaders = {\n    \"Authorization\": \"Bearer YOUR_ACCESS_TOKEN\",\n    \"Accept\": \"text/csv\"\n}\n\nresponse = requests.get(url, params=params, headers=headers)\nwith open(\"distribution_report.csv\", \"w\") as f:\n    f.write(response.text)\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Node","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import { writeFileSync } from 'fs';\n\nconst response = await fetch(\n  '[Your API Base URL]/v3/distribution-manager/reports/distributions/YOUR_DISTRIBUTION_ID/basic?pageNumber=1&pageSize=1000',\n  {\n    method: 'GET',\n    headers: {\n      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',\n      'Accept': 'text/csv'\n    }\n  }\n);\nconst csv = await response.text();\nwriteFileSync('distribution_report.csv', csv);\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept: text/csv"]}," header and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--output"]}," flag to save the file. The response streams directly to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distribution_report.csv"]}," in your current directory."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":4},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For the full set of V3 endpoints - payout instructions, bank accounts, transfers, templates, reports, and more - see the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference"]}," in the sidebar"]}]}]},"headings":[{"value":"Quickstart: Distribution Manager (V3)","id":"quickstart-distribution-manager-v3","depth":2},{"value":"1. List your distributions","id":"1-list-your-distributions","depth":3},{"value":"2. Get a single distribution","id":"2-get-a-single-distribution","depth":3},{"value":"3. Download a distribution report","id":"3-download-a-distribution-report","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Quickstart: Distribution Manager (V3)"}},"lastModified":"2026-06-17T12:09:53.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/get-started/quickstart-distributions","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}