List recipients
Recipients
List recipients
Returns the authenticated business’s recipient directory using opaque cursor pagination.
GET
List recipients
Authorizations
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
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 - 128Pattern:
^[A-Za-z0-9._:-]+$Query Parameters
Opaque cursor returned as meta.next_cursor. Do not construct or modify it.
Maximum string length:
512Number of resources to return.
Required range:
1 <= x <= 100Match recipient name or phone number.
Maximum string length:
128Match one normalized E.164 phone number.
Pattern:
^\+[1-9][0-9]{7,14}$