Parameters

Certain parameters have to be supplied in the URL path, as a JSON query, or as URL parameters.

path

URL path parameters

Example

In this example {invoiceId} in the path would be replaced by the value of the invoiceID:

GET /invoices/{invoiceId}

query

URI encoded URLSearchParams

Request body JSON

Some endpoints will show a request body JSON schema that specifies the format for JSON in your request body.

For example, PUT /invoices/{invoiceId} requires JSON data in the body.


Table of contents