Skip to main content
GET
Get contact list

Authorizations

X-YoLead-Key
string
header
required

Public API key generated in the YoLead UI.

X-YoLead-Timestamp
string
header
required

Unix timestamp in milliseconds. Requests must be signed within a 5-minute window.

X-YoLead-Signature
string
header
required

Hex HMAC-SHA256 signature over <timestamp>.<raw_body> using the API secret.

Path Parameters

listId
string
required

List id. MongoDB ObjectId represented as a 24-character hexadecimal string.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64f000000000000000000001"

Query Parameters

page
integer
default:1

Page number; defaults to 1.

Required range: x >= 1
limit
integer
default:20

Items per page; defaults to 20 and cannot exceed 100.

Required range: 1 <= x <= 100

Response

List and members.

data
object
required