Skip to main content
GET
List recipients

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._:-]+$

Query Parameters

cursor
string

Opaque cursor returned as meta.next_cursor. Do not construct or modify it.

Maximum string length: 512
limit
integer
default:25

Number of resources to return.

Required range: 1 <= x <= 100

Match recipient name or phone number.

Maximum string length: 128
phone_number
string

Match one normalized E.164 phone number.

Pattern: ^\+[1-9][0-9]{7,14}$

Response

Recipient page returned.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200
message
string
required
data
object[]
required
meta
object
required