This action allows you to make a custom, authenticated API request to the Showpad API.

Options:

  • Request Type (dropdown): your available HTTP request methods. There are 5 supported HTTP request methods (sometimes called verbs) in custom API calls:

    • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

    • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.

    • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.

    • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

    • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

Input Fields:

  • Relative URL (string): This is everything that comes after https://yoursubdomain.showpad.biz/api. Note that you need to specify the API version number in this field.

    Example: /v3/assets.json
  • Query (object): Any query parameters can be passed as an object.

    Example: {"name":"test"}
  • Body (object): Any body parameters can be passed as an object.

    Example: {"name":"test"}
  • Headers (object): Any additional headers that you need for your request. You do not need to enter “Authorization” headers, as these will be added to the call when it runs.

    Example: {"Content-type":"text/html"}

Output Fields:

  • Status Code (Number): the success or failure of your HTTP request. Here is a list of all status codes.

  • Headers (object): a more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you. The response headers are dependent on the HTTP request you choose in options.

  • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.