Lead Inbox

List inbox cards

get/api/v1/leads/inbox

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/leads/inbox
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

accountRefstring

Legacy dashboard filter; ignored for tenancy.

agentRefstring

Only return leads captured by this agent.

statusstring

Only return leads with this status.

searchstring

Search by contact fields and tags.

stagestring

Only return conversations that reached at least this stage.

stepstring

Alias for stage.

userSegmentstring

Only return leads tagged with this user segment.

obstaclestring

Only return leads tagged with this obstacle.

test'all' | 'real' | 'test'

Filter test conversations.

startDatestring

UTC date YYYY-MM-DD lower bound.

endDatestring

UTC date YYYY-MM-DD upper bound.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.