Path Parameters

Path parameters limit a request to one individual resource. They help you to retrieve, update, or delete information about a specific entity. A path parameter is a variable part of the URL, in curly braces ({…}). In the Gotransverse JSON REST API, path parameters usually denote various types of ID. They are listed in API reference documentation with the label path.

Path Parameter

To use a path parameter, replace the path parameter’s name and curly braces with the necessary value. For example, to get the data about a certain billing account using the endpoint /billing-accounts/{id}, format a request with a path parameter in the following way:

GET https://example-gotransverse.com/billing/2/billing-accounts/1234567