Skip to main content
GET
Get a recipient address

Authorizations

Authorization
string
header
required

A business-bound HaulStow API key. Send Authorization: Bearer hsg_live_key_... to the live server or a hsg_test_key_... key to the sandbox server. Never expose this key in a browser.

Headers

X-Request-ID
string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

address_id
string
required
Pattern: ^adr_[a-f0-9]{32}$
Example:

"adr_78de60204f574a64be88ba9bd94a049f"

Response

Address returned.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200,
201
message
string
required
data
object
required