Skip to main content
The Supply API endpoints are designed to be used together as part of a business process. The steps below walk through a typical end-to-end workflow. For the example, assume a fictitious Survey 2634 is available to you, and that it contains a Stream 849. All calls require your API key in the Authorization header. The examples use the staging base URL https://stage-api.researchdesk.com; swap in https://api.researchdesk.com for production.
1

Retrieve your allocations

Call the Surveys endpoint to obtain the list of Surveys and Streams available to you. Assume you see Survey 2634 and, within it, Stream 849.
See List Surveys & Streams.
2

Identify the target Stream

For the remainder of this workflow, focus on Survey 2634 and the Stream 849 belonging to it. You can also fetch a single survey directly:
See Get Survey.
3

Get the Stream's qualifications

Retrieve the qualifications (respondent eligibility criteria) for Stream 849.
See Get Stream Qualifications.
4

Get the Stream's quotas

Retrieve the quotas for Stream 849 so you know which cells are open and how many completes remain.
See Get Stream Quotas.
5

Create the entry links

Create the live and test entry links for Stream 849, supplying your redirect URLs in the request body. Use [%rid%] (case sensitive) to pass back the Respondent ID that was originally passed into the entry link as [%RID%].
See Create Links.
6

(Optional) Update the entry links

If you need a different survey link for any reason, use the Update Links endpoint to generate a new link for Stream 849, passing the lud and tud values returned in the previous step.
See Update Links.
Polling: During fieldwork, poll the Surveys and Quotas endpoints every 2–3 minutes to detect changes. Use the Remaining (Surveys) and QuotaRemaining (Quotas) fields as your primary indicators of whether more respondents are needed. When a value reaches 0, pause sample to that Stream or quota cell.
Before sending respondents, review Passing Respondent Data to Research Desk for the profiling values that must be appended to entry links.