Skip to main content
GET
Get Contacts

Authorizations

Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Query Parameters

userId
integer
Required range: x >= 1
statuses
enum<string>[]
Available options:
POTENTIAL,
QUALIFIED,
DISQUALIFIED,
STRATEGY_CALL_BOOKED,
DISCOVERY_CALL_BOOKED
eventIds
integer[]
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
page
integer
default:0
Required range: x >= 0
timeFrom
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
timeTo
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
orderBy
enum<string>
Available options:
asc,
desc
orderColumn
enum<string>
Available options:
id,
createdAt,
updatedAt,
joinedTime,
firstName,
lastName,
email

Response

Paginated list of contacts

data
object
required