Parameter type Description

Header Parameters included in the request header, usually related to authorisation

Path Parameters within the path of the endpoint, before the query string (?). These are usually enclosed in curly braces {path parameter}.

The path parameter is often a URI for a resource. For example, {product_id}.

These types of parameters are mainly used in PUT and GET requests.

Query string Parameters in the query string of the endpoint, after the (?).

This parameter can also be used to submit arrays. For example, to pass several foo_ids fields, use:

/v1/endpoint?foo_ids=1&foo_ids=2&foo_ids=3

These types of parameters are mainly used in GET requests to list endpoints.

Request body Parameters included in the request body. Usually submitted in JSON format.