Skip to content

API Parameters

Mahmoud A. Zaid edited this page Mar 23, 2019 · 1 revision

What is the API Parameters?

  • Parameters are options you can pass with the endpoint to influence the response.

Types Of Parameters:

  1. Header parameters:
  • Parameters included in the request header, usually related to authorization.
  1. Path parameters:
  • Parameters within the path of the endpoint, before the query string (?). These are usually set off within curly braces. eg: http://dummy.restapiexample.com/employee/{id}
  1. Query string parameters:
  • Parameters in the query string of the endpoint, after the ?. eg: /surfreport/{beachId}?days=3&units=metric&time=1400
  1. Request body parameters:
  • Parameters included in the request body. Usually submitted as JSON. eg: {"name":"test","salary":"123","age":"23","id":"719"}