Skip to main content
GET
Who a lead was assigned to

Authorizations

Authorization
string
header
required

The access_token returned by POST /oauth2/token, sent as Authorization: Bearer <access_token>. It is an opaque string, not a JWT.

Path Parameters

id
string<uuid>
required

Lead id returned by POST /public/leads. A merged id works too.

Response

Assignment state

Who a lead ended up with. Branch on status, not on whether agent is set.

leadId
string<uuid>
required
status
enum<string>
required

assigned = a real agent owns it, contact them. pending = routing has not finished, ask again after retryAfterSeconds and tell the customer nothing yet. unassigned = routing ran and nobody took it; FINAL, send the generic reply and notify no one. pool = deliberately ownerless in a shared pool until an agent claims it; also a generic reply. unassigned and pool together account for roughly 30% of leads — they are not errors.

Available options:
assigned,
pending,
unassigned,
pool
agent
object | null
required

Populated only when status is assigned.

createdAt
string<date-time>
required

When the lead was created.

retryAfterSeconds
integer | null
required

Seconds to wait before asking again. Non-null only when status is pending.