read_leads
Read leads, their contact points, campaign/list membership views, timelines, and notes. Set view to list (default), get, campaign, lead_list, timeline, search, contact_points, or notes.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## read_leads
Read leads, their contact points, campaign/list membership views, timelines, and notes. Set view to list (default), get, campaign, lead_list, timeline, search, contact_points, or notes.
Use view=list to page workspace leads (the default); choose get, campaign, lead_list, timeline, search, contact_points, or notes for the corresponding read.
There is no bulk export; page with bounds instead. Hidden timeline sources are reported, not failures.
Scopes: lead:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"view": {
"type": "string",
"enum": [
"list",
"get",
"campaign",
"lead_list",
"timeline",
"search",
"contact_points",
"notes"
]
},
"leadId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadListId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"query": {
"type": "string"
},
"offset": {
"type": "integer",
"minimum": 0
},
"sortBy": {
"type": "string",
"enum": [
"firstName",
"lastName",
"company",
"createdAt",
"updatedAt",
"email",
"ladder",
"rank"
]
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"assigneeUserIds": {
"type": "string"
},
"cursorAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"cursorId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"cursor": {
"$ref": "#/$defs/Cursor"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId|view|leadId|leadListId|campaignId|query|offset|sortBy|sortOrder|assigneeUserIds|cursorAt|cursorId|cursor|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"view",
"leadId",
"leadListId",
"campaignId",
"query",
"offset",
"sortBy",
"sortOrder",
"assigneeUserIds",
"cursorAt",
"cursorId",
"cursor",
"limit"
]
},
"$defs": {
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"view": {
"type": "string",
"enum": [
"list",
"get",
"campaign",
"lead_list",
"timeline",
"search",
"contact_points",
"notes"
]
},
"leadId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadListId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"query": {
"type": "string"
},
"offset": {
"type": "integer",
"minimum": 0
},
"sortBy": {
"type": "string",
"enum": [
"firstName",
"lastName",
"company",
"createdAt",
"updatedAt",
"email",
"ladder",
"rank"
]
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"assigneeUserIds": {
"type": "string"
},
"cursorAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"cursorId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"cursor": {
"$ref": "#/$defs/Cursor"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId|view|leadId|leadListId|campaignId|query|offset|sortBy|sortOrder|assigneeUserIds|cursorAt|cursorId|cursor|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"view",
"leadId",
"leadListId",
"campaignId",
"query",
"offset",
"sortBy",
"sortOrder",
"assigneeUserIds",
"cursorAt",
"cursorId",
"cursor",
"limit"
]
},
"$defs": {
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"LeadStoredText": {
"type": "string",
"maxLength": 65536
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"NonEmptyString": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Union_": {
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Union_"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
}
]
},
"Cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"ladder": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"activity": {
"type": "object",
"properties": {
"campaignCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"emailCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"callCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordingCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lastActivityAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
],
"patternProperties": {
"^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
]
}
}
},
"required": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
],
"patternProperties": {
"^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
]
}
}
},
"activityVisibility": {
"type": "object",
"properties": {
"campaigns": {
"type": "boolean"
},
"replies": {
"type": "boolean"
},
"calls": {
"type": "boolean"
}
},
"required": [
"campaigns",
"replies",
"calls"
],
"patternProperties": {
"^(?!(?:campaigns|replies|calls)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaigns",
"replies",
"calls"
]
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"activityVisibility",
"pagination"
],
"patternProperties": {
"^(?!(?:items|activityVisibility|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"activityVisibility",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"organizationId": {
"type": "string"
},
"emailAddress": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneBase": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneExtension": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"locality": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"organizationId",
"emailAddress",
"phoneNumber",
"phoneBase",
"phoneExtension",
"firstName",
"lastName",
"companyName",
"companyWebsiteUrl",
"jobTitle",
"locality",
"region",
"country",
"timezone",
"personalLinkedInUrl",
"companyLinkedInUrl",
"source",
"customFieldValues",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"organizationId",
"emailAddress",
"phoneNumber",
"phoneBase",
"phoneExtension",
"firstName",
"lastName",
"companyName",
"companyWebsiteUrl",
"jobTitle",
"locality",
"region",
"country",
"timezone",
"personalLinkedInUrl",
"companyLinkedInUrl",
"source",
"customFieldValues",
"createdAt",
"updatedAt"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"email": {
"$ref": "#/$defs/LeadStoredText"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyDomain": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "string",
"enum": [
"not_contacted",
"contacted",
"completed",
"task_pending",
"task_failed",
"paused",
"out_of_office",
"bounced",
"unsubscribed",
"ladder_queued",
"moved_to_subsequence"
]
},
"bounceCategory": {
"anyOf": [
{
"type": "string",
"enum": [
"recipient",
"sender"
]
},
{
"type": "null"
}
]
},
"recipientEsp": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"emailSecurityGateway": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"assignees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"isFormerMember": {
"type": "boolean"
}
},
"required": [
"userId",
"name",
"email",
"image",
"isFormerMember"
],
"patternProperties": {
"^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"userId",
"name",
"email",
"image",
"isFormerMember"
]
}
}
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"hexColor": {
"$ref": "#/$defs/ShortText"
},
"sentiment": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"custom",
"default"
]
}
},
"required": [
"id",
"name",
"hexColor",
"sentiment",
"type"
],
"patternProperties": {
"^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"hexColor",
"sentiment",
"type"
]
}
}
}
},
"required": [
"id",
"leadId",
"email",
"firstName",
"lastName",
"company",
"jobTitle",
"companyDomain",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"status",
"recipientEsp",
"emailSecurityGateway",
"assignees",
"labels"
],
"patternProperties": {
"^(?!(?:id|leadId|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|status|bounceCategory|recipientEsp|emailSecurityGateway|assignees|labels)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"leadId",
"email",
"firstName",
"lastName",
"company",
"jobTitle",
"companyDomain",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"status",
"bounceCategory",
"recipientEsp",
"emailSecurityGateway",
"assignees",
"labels"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"ladder": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"activity": {
"type": "object",
"properties": {
"campaignCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"emailCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"callCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordingCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lastActivityAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
],
"patternProperties": {
"^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
]
}
}
},
"required": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
],
"patternProperties": {
"^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_enrolled"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignName": {
"$ref": "#/$defs/LeadStoredText"
},
"status": {
"type": "string",
"enum": [
"not_contacted",
"contacted",
"completed",
"task_pending",
"task_failed",
"paused",
"out_of_office",
"bounced",
"unsubscribed",
"ladder_queued",
"moved_to_subsequence"
]
},
"bounceCategory": {
"anyOf": [
{
"type": "string",
"enum": [
"recipient",
"sender"
]
},
{
"type": "null"
}
]
},
"emailAddress": {
"$ref": "#/$defs/LeadStoredText"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"status",
"emailAddress"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|status|bounceCategory|emailAddress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"status",
"bounceCategory",
"emailAddress"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_sent"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"campaignName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"threadId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"firstOpenedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"threadId",
"openCount",
"firstOpenedAt"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|threadId|openCount|firstOpenedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"threadId",
"openCount",
"firstOpenedAt"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_opened"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"openCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignName",
"openCount"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignName|openCount)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignName",
"openCount"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_replied"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"from": {
"$ref": "#/$defs/LeadStoredText"
},
"subject": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"snippet": {
"type": "string"
},
"threadId": {
"type": "string"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"from",
"subject",
"snippet",
"threadId"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|from|subject|snippet|threadId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"from",
"subject",
"snippet",
"threadId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"task"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"title": {
"$ref": "#/$defs/LeadStoredText"
},
"completedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcome": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"title",
"completedAt",
"outcome"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|title|completedAt|outcome)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"title",
"completedAt",
"outcome"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"call"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"direction": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"counterpartyPhoneE164": {
"$ref": "#/$defs/ShortText"
},
"repUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"repName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"disposition": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"hasRecording": {
"type": "boolean"
},
"hasTranscript": {
"type": "boolean"
},
"aiSummary": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"direction",
"status",
"durationSeconds",
"counterpartyPhoneE164",
"repUserId",
"repName",
"disposition",
"note",
"hasRecording",
"hasTranscript",
"aiSummary"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|direction|status|durationSeconds|counterpartyPhoneE164|repUserId|repName|disposition|note|hasRecording|hasTranscript|aiSummary)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"direction",
"status",
"durationSeconds",
"counterpartyPhoneE164",
"repUserId",
"repName",
"disposition",
"note",
"hasRecording",
"hasTranscript",
"aiSummary"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"contact_point"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"pointKind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/LeadStoredText"
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"pointKind",
"value",
"badReason"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|pointKind|value|badReason)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"pointKind",
"value",
"badReason"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"crm_note_pushed"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"sourceKind": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"provider",
"sourceKind"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|provider|sourceKind)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"provider",
"sourceKind"
]
}
}
]
}
},
"nextCursor": {
"anyOf": [
{
"$ref": "#/$defs/Cursor"
},
{
"type": "null"
}
]
},
"hiddenSources": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"undatedEnrollments": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"events",
"nextCursor",
"hiddenSources",
"undatedEnrollments"
],
"patternProperties": {
"^(?!(?:events|nextCursor|hiddenSources|undatedEnrollments)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"events",
"nextCursor",
"hiddenSources",
"undatedEnrollments"
]
}
},
{
"type": "object",
"properties": {
"leads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"emailAddress": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"firstName",
"lastName",
"companyName",
"jobTitle",
"emailAddress",
"phoneNumber",
"source"
],
"patternProperties": {
"^(?!(?:id|firstName|lastName|companyName|jobTitle|emailAddress|phoneNumber|source)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"firstName",
"lastName",
"companyName",
"jobTitle",
"emailAddress",
"phoneNumber",
"source"
]
}
},
"maxItems": 25
}
},
"required": [
"leads"
],
"patternProperties": {
"^(?!(?:leads)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"leads"
]
}
]
}
},
{
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"ladder": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"$ref": "#/$defs/ShortText"
},
"rank": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"key",
"rank"
],
"patternProperties": {
"^(?!(?:id|key|rank)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"key",
"rank"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"emails",
"phones",
"ladder"
],
"patternProperties": {
"^(?!(?:emails|phones|ladder)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"emails",
"phones",
"ladder"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"body": {
"type": "string"
},
"authorUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"authorName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"leadId",
"body",
"authorUserId",
"authorName",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"leadId",
"body",
"authorUserId",
"authorName",
"createdAt"
]
}
},
"maxItems": 50
},
"nextCursor": {
"anyOf": [
{
"type": "object",
"properties": {
"at": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"at",
"id"
],
"patternProperties": {
"^(?!(?:at|id)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"at",
"id"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"nextCursor"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"ladder": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"activity": {
"type": "object",
"properties": {
"campaignCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"emailCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"callCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordingCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lastActivityAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
],
"patternProperties": {
"^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
]
}
}
},
"required": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
],
"patternProperties": {
"^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
]
}
}
},
"activityVisibility": {
"type": "object",
"properties": {
"campaigns": {
"type": "boolean"
},
"replies": {
"type": "boolean"
},
"calls": {
"type": "boolean"
}
},
"required": [
"campaigns",
"replies",
"calls"
],
"patternProperties": {
"^(?!(?:campaigns|replies|calls)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaigns",
"replies",
"calls"
]
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"activityVisibility",
"pagination"
],
"patternProperties": {
"^(?!(?:items|activityVisibility|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"activityVisibility",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"organizationId": {
"type": "string"
},
"emailAddress": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneBase": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneExtension": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"locality": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"organizationId",
"emailAddress",
"phoneNumber",
"phoneBase",
"phoneExtension",
"firstName",
"lastName",
"companyName",
"companyWebsiteUrl",
"jobTitle",
"locality",
"region",
"country",
"timezone",
"personalLinkedInUrl",
"companyLinkedInUrl",
"source",
"customFieldValues",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"organizationId",
"emailAddress",
"phoneNumber",
"phoneBase",
"phoneExtension",
"firstName",
"lastName",
"companyName",
"companyWebsiteUrl",
"jobTitle",
"locality",
"region",
"country",
"timezone",
"personalLinkedInUrl",
"companyLinkedInUrl",
"source",
"customFieldValues",
"createdAt",
"updatedAt"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"email": {
"$ref": "#/$defs/LeadStoredText"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyDomain": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "string",
"enum": [
"not_contacted",
"contacted",
"completed",
"task_pending",
"task_failed",
"paused",
"out_of_office",
"bounced",
"unsubscribed",
"ladder_queued",
"moved_to_subsequence"
]
},
"bounceCategory": {
"anyOf": [
{
"type": "string",
"enum": [
"recipient",
"sender"
]
},
{
"type": "null"
}
]
},
"recipientEsp": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"emailSecurityGateway": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"assignees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"isFormerMember": {
"type": "boolean"
}
},
"required": [
"userId",
"name",
"email",
"image",
"isFormerMember"
],
"patternProperties": {
"^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"userId",
"name",
"email",
"image",
"isFormerMember"
]
}
}
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"hexColor": {
"$ref": "#/$defs/ShortText"
},
"sentiment": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"custom",
"default"
]
}
},
"required": [
"id",
"name",
"hexColor",
"sentiment",
"type"
],
"patternProperties": {
"^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"hexColor",
"sentiment",
"type"
]
}
}
}
},
"required": [
"id",
"leadId",
"email",
"firstName",
"lastName",
"company",
"jobTitle",
"companyDomain",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"status",
"recipientEsp",
"emailSecurityGateway",
"assignees",
"labels"
],
"patternProperties": {
"^(?!(?:id|leadId|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|status|bounceCategory|recipientEsp|emailSecurityGateway|assignees|labels)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"leadId",
"email",
"firstName",
"lastName",
"company",
"jobTitle",
"companyDomain",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"status",
"bounceCategory",
"recipientEsp",
"emailSecurityGateway",
"assignees",
"labels"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyWebsiteUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"personalLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyLinkedInUrl": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"customFieldValues": {
"type": "object",
"additionalProperties": true
},
"ladder": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"rank": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"activity": {
"type": "object",
"properties": {
"campaignCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"emailCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"callCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordingCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lastActivityAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
],
"patternProperties": {
"^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignCount",
"emailCount",
"replyCount",
"callCount",
"recordingCount",
"lastActivityAt"
]
}
}
},
"required": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
],
"patternProperties": {
"^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"email",
"firstName",
"lastName",
"company",
"phoneNumber",
"jobTitle",
"companyWebsiteUrl",
"personalLinkedInUrl",
"companyLinkedInUrl",
"city",
"state",
"country",
"timezone",
"customFieldValues",
"ladder",
"rank",
"createdAt",
"updatedAt",
"emails",
"phones",
"activity"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_enrolled"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignName": {
"$ref": "#/$defs/LeadStoredText"
},
"status": {
"type": "string",
"enum": [
"not_contacted",
"contacted",
"completed",
"task_pending",
"task_failed",
"paused",
"out_of_office",
"bounced",
"unsubscribed",
"ladder_queued",
"moved_to_subsequence"
]
},
"bounceCategory": {
"anyOf": [
{
"type": "string",
"enum": [
"recipient",
"sender"
]
},
{
"type": "null"
}
]
},
"emailAddress": {
"$ref": "#/$defs/LeadStoredText"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"status",
"emailAddress"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|status|bounceCategory|emailAddress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"status",
"bounceCategory",
"emailAddress"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_sent"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"campaignName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"threadId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"firstOpenedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"threadId",
"openCount",
"firstOpenedAt"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|threadId|openCount|firstOpenedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignId",
"campaignName",
"threadId",
"openCount",
"firstOpenedAt"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_opened"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"campaignName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"openCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"campaignName",
"openCount"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|campaignName|openCount)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"campaignName",
"openCount"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"email_replied"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"from": {
"$ref": "#/$defs/LeadStoredText"
},
"subject": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"snippet": {
"type": "string"
},
"threadId": {
"type": "string"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"from",
"subject",
"snippet",
"threadId"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|from|subject|snippet|threadId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"from",
"subject",
"snippet",
"threadId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"task"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"title": {
"$ref": "#/$defs/LeadStoredText"
},
"completedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcome": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"title",
"completedAt",
"outcome"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|title|completedAt|outcome)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"title",
"completedAt",
"outcome"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"call"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"direction": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"counterpartyPhoneE164": {
"$ref": "#/$defs/ShortText"
},
"repUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"repName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"disposition": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"hasRecording": {
"type": "boolean"
},
"hasTranscript": {
"type": "boolean"
},
"aiSummary": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"direction",
"status",
"durationSeconds",
"counterpartyPhoneE164",
"repUserId",
"repName",
"disposition",
"note",
"hasRecording",
"hasTranscript",
"aiSummary"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|direction|status|durationSeconds|counterpartyPhoneE164|repUserId|repName|disposition|note|hasRecording|hasTranscript|aiSummary)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"direction",
"status",
"durationSeconds",
"counterpartyPhoneE164",
"repUserId",
"repName",
"disposition",
"note",
"hasRecording",
"hasTranscript",
"aiSummary"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"contact_point"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"pointKind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/LeadStoredText"
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"pointKind",
"value",
"badReason"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|pointKind|value|badReason)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"pointKind",
"value",
"badReason"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"crm_note_pushed"
]
}
]
},
"occurredAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"sortId": {
"type": "string"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"sourceKind": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"kind",
"occurredAt",
"sortId",
"provider",
"sourceKind"
],
"patternProperties": {
"^(?!(?:kind|occurredAt|sortId|provider|sourceKind)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"occurredAt",
"sortId",
"provider",
"sourceKind"
]
}
}
]
}
},
"nextCursor": {
"anyOf": [
{
"$ref": "#/$defs/Cursor"
},
{
"type": "null"
}
]
},
"hiddenSources": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"undatedEnrollments": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"events",
"nextCursor",
"hiddenSources",
"undatedEnrollments"
],
"patternProperties": {
"^(?!(?:events|nextCursor|hiddenSources|undatedEnrollments)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"events",
"nextCursor",
"hiddenSources",
"undatedEnrollments"
]
}
},
{
"type": "object",
"properties": {
"leads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"companyName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"emailAddress": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"phoneNumber": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"firstName",
"lastName",
"companyName",
"jobTitle",
"emailAddress",
"phoneNumber",
"source"
],
"patternProperties": {
"^(?!(?:id|firstName|lastName|companyName|jobTitle|emailAddress|phoneNumber|source)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"firstName",
"lastName",
"companyName",
"jobTitle",
"emailAddress",
"phoneNumber",
"source"
]
}
},
"maxItems": 25
}
},
"required": [
"leads"
],
"patternProperties": {
"^(?!(?:leads)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"leads"
]
}
]
}
},
{
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"kind": {
"type": "string",
"enum": [
"email",
"phone"
]
},
"value": {
"$ref": "#/$defs/NonEmptyString"
},
"contactType": {
"$ref": "#/$defs/LeadStoredText"
},
"sourceValue": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"enum": [
"active",
"bad"
]
},
"badReason": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"badAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
],
"patternProperties": {
"^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"kind",
"value",
"contactType",
"sourceValue",
"position",
"status",
"badReason",
"badAt"
]
}
}
},
"ladder": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"$ref": "#/$defs/ShortText"
},
"rank": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"key",
"rank"
],
"patternProperties": {
"^(?!(?:id|key|rank)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"key",
"rank"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"emails",
"phones",
"ladder"
],
"patternProperties": {
"^(?!(?:emails|phones|ladder)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"emails",
"phones",
"ladder"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"leadId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"body": {
"type": "string"
},
"authorUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"authorName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"leadId",
"body",
"authorUserId",
"authorName",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"leadId",
"body",
"authorUserId",
"authorName",
"createdAt"
]
}
},
"maxItems": 50
},
"nextCursor": {
"anyOf": [
{
"type": "object",
"properties": {
"at": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"at",
"id"
],
"patternProperties": {
"^(?!(?:at|id)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"at",
"id"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"nextCursor"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `leads.list`: `GET /v1/workspaces/:workspaceId/leads`
- `leads.get`: `GET /v1/workspaces/:workspaceId/leads/:leadId`
- `leads.listByCampaign`: `GET /v1/workspaces/:workspaceId/leads/by-campaign/:campaignId`
- `leads.listByList`: `GET /v1/workspaces/:workspaceId/leads/by-list/:leadListId`
- `leads.timeline`: `GET /v1/workspaces/:workspaceId/leads/:leadId/timeline`
- `leads.search`: `POST /v1/workspaces/:workspaceId/leads/search`
- `leads.contactPoints`: `GET /v1/workspaces/:workspaceId/leads/:leadId/contact-points`
- `leads.notes.list`: `GET /v1/workspaces/:workspaceId/leads/:leadId/notes`
Scheduler Zero