All Collections
Submittable's API
API Basics
How can I use Postman to run an API call to Submittable?
How can I use Postman to run an API call to Submittable?

Postman is an HTTP Client which allows you to easily create requests in order to get data from Submittable's API.

Pam English avatar
Written by Pam English
Updated over a week ago

Postman is an API client that provides tools and a friendly interface to interact with an API such as Submittable's. This is done by allowing users to create and save simple and complex HTTP/s requests, as well as read their responses. We recommend using Postman as an easy way to connect to Submittable's API.

You can use Postman as a full-featured collaboration platform for API development and testing. Learn the Postman fundamentals in this video course for beginners.

How to set up Postman and Authenticate Submittable's API

The following are instructions on how to download and import Submittable's swagger docs into Postman and set up your first API call.

  1. Download a free version of Postman here and install it.

  2. After downloading/installing Postman, go here to download Submittable's Beta API Documentation (v3).

  3. Open Postman. Select the option to Import an existing file.

  4. Click Upload Files.

  5. Navigate to your Downloads Folder, and select the file labeled swagger_[date}.json. It will look like this:

  6. Choose this file and check Generate collection from imported APIs. Then click Import.

  7. This will populate a Collection for Submittable's Beta v3 API Documentation.

Authenticate Using Postman

  1. Click on Collections, then select the 3-dot ellipsis next to the title for Submittable's Beta API Documentation to open the drop down menu.
    Select Edit from the menu.

2. Select Basic Auth from the Type menu:

3. In the Username entry box, enter the API key that you retrieved from your Submittable account page. You do not need an additional password.

4. Press return. Authentication on Postman should be complete. You'll see the sections of Submittable's v3 API in the column over to the left. You're ready to make API calls.


Did this answer your question?