--- agentTools: projectIndex: https://clientsuccess.readme.io/llms.txt --- # /contact/search Search for contacts using parameters # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "ClientSuccess API", "description": "ClientSuccess CNS API", "version": "v2.0.0" }, "servers": [ { "url": "https://api.clientsuccess.com/v2" } ], "security": [ { "gen-auth": [] } ], "paths": { "/contact/search": { "get": { "tags": [ "Contact" ], "description": "Search for contacts using parameters", "operationId": "searchContacts", "parameters": [ { "name": "ids", "in": "query", "description": "Set of contacts ids", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "tenantClientId", "in": "query", "description": "ClientSuccess system Client ID", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "description": "Contact status (can include more than 1)", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] } } }, { "name": "clientStatus", "in": "query", "description": "Client status (can include more than 1)", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "TRIAL", "TERMINATED" ] } } }, { "name": "name", "in": "query", "description": "Contact name", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Contact email", "required": false, "schema": { "type": "string" } }, { "name": "starred", "in": "query", "description": "Whether contact is starred", "required": false, "schema": { "type": "boolean" } }, { "name": "searchText", "in": "query", "description": "Search text across contact names, titles, emails, phone numbers, and notes ", "required": false, "schema": { "type": "string" } }, { "name": "externalSystemType", "in": "query", "description": "Type of external system contact is associated with", "required": false, "schema": { "type": "string", "enum": [ "SALESFORCE", "LINKEDIN", "ZENDESK", "EXCEL", "GOOGLE", "STRIPE", "DESK", "SLACK", "FRESHDESK", "USERVOICE", "JIRA", "IMAP", "INTERCOM", "OFFICE365", "DELIGHTED", "CLOUD_ELEMENTS", "MEDALLIA", "ASKNICELY", "HUBSPOT", "CLIENTSUCCESS", "SALESFORCE_V2", "ZENDESK_V2", "FRESHDESK_V2", "JIRA_V2", "PIPEDRIVE", "EMAIL_ADV", "ZOHOCRM", "HELPSCOUT", "IMPORT", "SATISMETER", "ZOOM", "SERVICE_NOW", "STATUS", "MICROSOFT_DYNAMICS", "PRODUCT_SIGNALS", "MICROSOFT_CALENDAR", "BATON", "GONG", "CHORUS" ] } }, { "name": "workatoPushExternalSystemType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SALESFORCE", "LINKEDIN", "ZENDESK", "EXCEL", "GOOGLE", "STRIPE", "DESK", "SLACK", "FRESHDESK", "USERVOICE", "JIRA", "IMAP", "INTERCOM", "OFFICE365", "DELIGHTED", "CLOUD_ELEMENTS", "MEDALLIA", "ASKNICELY", "HUBSPOT", "CLIENTSUCCESS", "SALESFORCE_V2", "ZENDESK_V2", "FRESHDESK_V2", "JIRA_V2", "PIPEDRIVE", "EMAIL_ADV", "ZOHOCRM", "HELPSCOUT", "IMPORT", "SATISMETER", "ZOOM", "SERVICE_NOW", "STATUS", "MICROSOFT_DYNAMICS", "PRODUCT_SIGNALS", "MICROSOFT_CALENDAR", "BATON", "GONG", "CHORUS" ] } }, { "name": "externalSystemId", "in": "query", "description": "Contact External System ID", "required": false, "schema": { "type": "string" } }, { "name": "createdBefore", "in": "query", "description": "Contact Created Before Date", "required": false, "schema": { "type": "string", "format": "date", "example": "2019-05-20" } }, { "name": "createdAfter", "in": "query", "description": "Contact Created After Date", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-05-20" } }, { "name": "modifiedBefore", "in": "query", "description": "Contact Modified Before Date", "required": false, "schema": { "type": "string", "format": "date", "example": "2019-05-20" } }, { "name": "modifiedAfter", "in": "query", "description": "Contact Modified After Date", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-05-20" } }, { "name": "sortBy", "in": "query", "description": "Criteria to sort by (default 'createdTime')", "required": false, "schema": { "pattern": "createdTime|modifiedTime|firstName|lastName|email|lastEngagementDate|engagementCount", "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction (default 'asc')", "required": false, "schema": { "pattern": "asc|desc", "type": "string" } }, { "name": "page", "in": "query", "description": "Result page index (default 0)", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Number of results per page (default 100)", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageResultClientContactSearch" } } } } } } } }, "components": { "schemas": { "JSONObject": { "type": "object" }, "CampaignSummary": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" } } }, "ClientContactEngagement": { "type": "object", "properties": { "interactionTypeId": { "type": "integer", "format": "int64" }, "interactionCount": { "type": "integer", "format": "int64" }, "lastInteractionDate": { "type": "string", "format": "date-time" }, "engagementCount": { "type": "integer", "format": "int64" }, "lastEngagementDate": { "type": "string", "format": "date-time" } } }, "ClientContactSearch": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "createdTime": { "type": "string", "format": "date-time" }, "modifiedTime": { "type": "string", "format": "date-time" }, "custom": { "$ref": "#/components/schemas/JSONObject" }, "tenantClientId": { "type": "integer", "format": "int64" }, "uuid": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "salesforceId": { "type": "string" }, "linkedinUrl": { "type": "string" }, "advocate": { "type": "boolean" }, "champion": { "type": "boolean" }, "executiveSponsor": { "type": "boolean" }, "starred": { "type": "boolean" }, "keyContact": { "type": "boolean" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "timezone": { "type": "string" }, "notes": { "type": "string" }, "tenantClient": { "$ref": "#/components/schemas/TenantClientSearchSummary" }, "engagementCount": { "type": "integer", "format": "int64" }, "lastEngagementDate": { "type": "string", "format": "date-time" }, "entityType": { "type": "string" }, "npsResult": { "$ref": "#/components/schemas/SurveyResponseSummarySearchSummary" }, "engagements": { "type": "array", "items": { "$ref": "#/components/schemas/ClientContactEngagement" } } } }, "SurveyResponseSummarySearchSummary": { "type": "object", "properties": { "lastCampaignResponseId": { "type": "integer", "format": "int64" }, "lastCampaignResponseDate": { "type": "string", "format": "date-time" }, "lastCampaignScore": { "type": "integer", "format": "int32" }, "lastCampaignComment": { "type": "string" }, "lastResentResponseId": { "type": "integer", "format": "int64" }, "lastResentTime": { "type": "string", "format": "date-time" }, "lastResentScore": { "type": "integer", "format": "int32" }, "lastResentComment": { "type": "string" }, "lastCampaign": { "$ref": "#/components/schemas/CampaignSummary" }, "lastResentCampaign": { "$ref": "#/components/schemas/CampaignSummary" } } }, "TenantClientSearchSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "TRIAL", "TERMINATED" ] } } }, "PageResultClientContactSearch": { "type": "object", "properties": { "first": { "type": "boolean" }, "last": { "type": "boolean" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientContactSearch" } } } } }, "securitySchemes": { "gen-auth": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 101, "1": 113, "2": 164, "3": 150, "4": 249, "5": 175, "6": 252, "7": 0, "8": 77, "9": 217, "10": 148, "11": 207 } } } ```