• INTEGRATIONS AND DEVELOPER API • SETUP GUIDE

How to List, Retrieve, and Update Submissions Through the API

By Rivio Support Team
2 min read

What you will achieve in this guide

Follow this step-by-step documentation to configure custom B2B registration forms, approval workflows, and customer tagging.

EXPECTED SETUP TIME 5-10 Minutes
COMPATIBILITY All Shopify Themes & Plans
TECHNICAL DIFFICULTY Zero Code Required

Use the Rivio REST API to read Shopify registration applications and update their approval status from your own system.

Before you begin

Use the intended service account and select the destination list, channel, spreadsheet tab, or endpoint. Decide whether you are testing a new-submission event or an approval event, and use a clearly identifiable test application.

The API is for submissions

The REST API lists applications, retrieves a known application, and updates status through the documented requests. It does not create or edit forms. Use the public base URL and paths from the current in-app documentation or downloadable collection.

Send Authorization: Bearer with the complete key and obtain a real submission ID from a list response before requesting detail or updating it. Approval through the API has the same consequential onboarding effects and approval-event behavior as other supported paths.

Set up this workflow

  1. Open Developer API and copy the public base URL from the in-app documentation.

  2. Create a key with read permission; include status-update permission only for writes.

  3. Send the key using Authorization: Bearer followed by the full key.

  4. Use the documented list GET request and obtain a submission ID from its response.

  5. Use the documented detail GET or status PATCH request with that submission ID.

  6. Inspect the API response and the app submission detail to verify the expected result.

Example

Use the downloaded collection to list submissions, copy one disposable submission ID, and retrieve that detail. Test a status update only with a key that permits it.

Expected result

The response and app record refer to the same application; write access is separate from read access.

Limits and important behavior

  • The API covers submissions, not form creation or editing.
  • Approval writes can create or link Shopify customers and optional companies and send approval integration events.
  • Use the exact endpoint paths, body values, and parameters from current in-app docs or the downloaded collection rather than guessing them.

Troubleshooting and verification

If a request fails, compare its endpoint and payload with the current in-app API docs or Postman collection. Use the application ID returned by a read. The API manages submissions; it does not create or edit forms. Honor Retry-After on a 429 response.

Screenshots to add

Screenshot placeholder: Capture the relevant app screen for “How to List, Retrieve, and Update Submissions Through the API” after completing the setup. Show the controls used to open Developer API and copy the public base URL from the in-app documentation. Add a second screenshot showing the result of this check: Inspect the API response and the app submission detail to verify the expected result. Use dummy applicant details and mask any secrets.

Related guides