> ## Documentation Index > Fetch the complete documentation index at: https://docs.talqui.chat/llms.txt > Use this file to discover all available pages before exploring further. # Search contacts > Searches the tenant's contacts by name, email or phone — the "contacts" group of the app-web Spotlight. Replaces the search branch of core-api `GET /tenants/:tenantID/contacts`. A full name matches word by word across first and last name. A term shaped like a conversation protocol (the last 12 hex characters of a sessionID) also returns the contact behind that conversation, first and with `matchedSessionID`, if the operator may read it. Returns HTTP 206 instead of 200 when more pages are available. ## OpenAPI ````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/contacts openapi: 3.0.3 info: description: >- Talqui is an omnichannel customer service platform that unifies conversations from WhatsApp, Instagram, Telegram, and many other channels into a single attendant panel, alongside a broader ecosystem of plugins and integrations. This API gives developers programmatic access to Talqui's services layer, exposing the operations needed to read and manage tenants, conversations, plugins, and related resources that power that platform. Authentication is available on behalf of an Operator (the default for this API), a Plugin Connection, or a Plugin — see the [Talqui authentication guide](https://docs.talqui.chat/guides/introduction/authentication/) for how each token is obtained and when to use it. Need help or have questions not covered here? Reach out to support@talqui.com. license: name: ISC url: https://opensource.org/license/isc-license-txt title: Talqui - Services API version: 0.69.1 servers: - description: Production url: https://services-api.talqui.chat security: [] tags: - name: Tenants - name: Settings - name: Analytics/Reports - name: Analytics - name: Campaigns - name: Campaigns/Models - name: Contacts - name: Contacts/Imports - name: Handoff links - name: Inboxes - name: Messages - name: Notifications - name: Sessions - name: Operators/Shortcuts - name: Operators - name: Plugins - name: Setup - name: Uploads paths: /v1/tenants/{tenantID}/contacts: get: tags: - Contacts summary: Search contacts description: >- Searches the tenant's contacts by name, email or phone — the "contacts" group of the app-web Spotlight. Replaces the search branch of core-api `GET /tenants/:tenantID/contacts`. A full name matches word by word across first and last name. A term shaped like a conversation protocol (the last 12 hex characters of a sessionID) also returns the contact behind that conversation, first and with `matchedSessionID`, if the operator may read it. Returns HTTP 206 instead of 200 when more pages are available. operationId: SearchContactsController parameters: - in: path name: tenantID required: true schema: description: The tenant whose contacts are searched. format: uuid 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|ffffffff-ffff-ffff-ffff-ffffffffffff)$ type: string - in: query name: search required: true schema: description: >- Free-text term. Every word must prefix the first or the last name; email and phone match the whole term. A 12-hex-character term is also looked up as a conversation protocol. maxLength: 120 minLength: 1 type: string - in: query name: page required: false schema: default: 1 description: 1-indexed page number to fetch. maximum: 9007199254740991 minimum: 1 type: integer - in: query name: perPage required: false schema: default: 50 description: Number of contacts per page (max 200). maximum: 200 minimum: 1 type: integer responses: '200': content: application/json: schema: additionalProperties: false properties: data: description: >- Contacts matching the term, newest first; protocol hits (page 1 only) come first. items: additionalProperties: false properties: contactBlock: description: >- Whether this contact is blocked from starting new sessions. type: boolean contactChannels: description: Channels this contact has interacted through. items: type: string type: array contactEmail: description: Email address of the contact. type: string contactEmailVerified: description: Whether the contact email address has been verified. type: boolean contactExternal: additionalProperties: type: string description: >- External identifiers for this contact, keyed by channel. type: object contactFirstname: description: First name of the contact. type: string contactID: description: Unique identifier for this contact. type: string contactLastSessionID: description: >- Identifier of the contact most recent session, if any. nullable: true type: string contactLastname: description: Last name of the contact. type: string contactMeta: additionalProperties: {} description: Arbitrary metadata attached to the contact. type: object contactNameVerified: description: Whether the contact name has been verified. type: boolean contactPhone: description: Phone number of the contact. type: string contactPhoneVerified: description: Whether the contact phone number has been verified. type: boolean contactPhoto: description: URL of the contact profile photo, if available. nullable: true type: string contactSummary: description: >- AI-generated summary of the relationship/history with this contact, if available. nullable: true type: string contactTags: description: Tags used for organizing/filtering contacts. items: type: string type: array createdAt: description: When this contact was created. format: date-time type: string matchedSessionID: description: >- Set when the contact was found by session protocol: the session whose protocol matched. The result should open this conversation rather than the contact last one. type: string organizationID: description: The Talqui organization this contact belongs to. type: string tenantID: description: The tenant this contact belongs to. type: string updatedAt: description: When this contact was last updated. format: date-time type: string required: - organizationID - tenantID - contactID - contactExternal - contactFirstname - contactLastname - contactNameVerified - contactPhone - contactPhoneVerified - contactEmail - contactEmailVerified - contactSummary - contactChannels - contactPhoto - contactTags - contactMeta - contactLastSessionID - contactBlock - createdAt - updatedAt type: object type: array meta: additionalProperties: false description: Pagination metadata. properties: count: description: Number of contacts in this page. type: number currentPage: description: The page returned by this response. type: number hasMore: description: Whether more pages are available. type: boolean perPage: description: Page size used for this response. type: number required: - hasMore - count - currentPage - perPage type: object required: - data - meta type: object description: Response for status 200. '206': content: application/json: schema: additionalProperties: false properties: data: description: >- Contacts matching the term, newest first; protocol hits (page 1 only) come first. items: additionalProperties: false properties: contactBlock: description: >- Whether this contact is blocked from starting new sessions. type: boolean contactChannels: description: Channels this contact has interacted through. items: type: string type: array contactEmail: description: Email address of the contact. type: string contactEmailVerified: description: Whether the contact email address has been verified. type: boolean contactExternal: additionalProperties: type: string description: >- External identifiers for this contact, keyed by channel. type: object contactFirstname: description: First name of the contact. type: string contactID: description: Unique identifier for this contact. type: string contactLastSessionID: description: >- Identifier of the contact most recent session, if any. nullable: true type: string contactLastname: description: Last name of the contact. type: string contactMeta: additionalProperties: {} description: Arbitrary metadata attached to the contact. type: object contactNameVerified: description: Whether the contact name has been verified. type: boolean contactPhone: description: Phone number of the contact. type: string contactPhoneVerified: description: Whether the contact phone number has been verified. type: boolean contactPhoto: description: URL of the contact profile photo, if available. nullable: true type: string contactSummary: description: >- AI-generated summary of the relationship/history with this contact, if available. nullable: true type: string contactTags: description: Tags used for organizing/filtering contacts. items: type: string type: array createdAt: description: When this contact was created. format: date-time type: string matchedSessionID: description: >- Set when the contact was found by session protocol: the session whose protocol matched. The result should open this conversation rather than the contact last one. type: string organizationID: description: The Talqui organization this contact belongs to. type: string tenantID: description: The tenant this contact belongs to. type: string updatedAt: description: When this contact was last updated. format: date-time type: string required: - organizationID - tenantID - contactID - contactExternal - contactFirstname - contactLastname - contactNameVerified - contactPhone - contactPhoneVerified - contactEmail - contactEmailVerified - contactSummary - contactChannels - contactPhoto - contactTags - contactMeta - contactLastSessionID - contactBlock - createdAt - updatedAt type: object type: array meta: additionalProperties: false description: Pagination metadata. properties: count: description: Number of contacts in this page. type: number currentPage: description: The page returned by this response. type: number hasMore: description: Whether more pages are available. type: boolean perPage: description: Page size used for this response. type: number required: - hasMore - count - currentPage - perPage type: object required: - data - meta type: object description: Response for status 206. '400': content: application/json: schema: properties: errors: items: oneOf: - $ref: '#/components/schemas/MissingTenantIDError' - $ref: '#/components/schemas/MissingOperatorIDError' - $ref: '#/components/schemas/RequestValidationError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- MissingTenantIDError (error_code 1001): tenantID absent from the URL. | MissingOperatorIDError (error_code 1063): the resolved identity carries no operatorID. | RequestValidationError (error_code 1002): params or query fail schema validation. '401': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnauthorizedError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.' '403': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/ForbiddenError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- ForbiddenError (error_code 1004): operator does not belong to this tenant. '404': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/TenantNotFoundError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- TenantNotFoundError (error_code 1062): tenantID does not resolve to a tenant (protocol lookup only). '500': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnknownError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- UnknownError (error_code 5999): Unexpected internal error not otherwise documented for this endpoint. components: schemas: MissingTenantIDError: additionalProperties: false properties: error: enum: - MissingTenantIDError type: string error_code: enum: - 1001 type: number message: example: tenantID is required. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object MissingOperatorIDError: additionalProperties: false properties: error: enum: - MissingOperatorIDError type: string error_code: enum: - 1063 type: number message: example: operatorID is required. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object RequestValidationError: additionalProperties: false properties: error: enum: - RequestValidationError type: string error_code: enum: - 1002 type: number fields: items: additionalProperties: false properties: allowed: type: string field: type: string received: type: string required: - field - received - allowed type: object type: array message: example: Invalid request data. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message - fields type: object UnauthorizedError: additionalProperties: false properties: error: enum: - UnauthorizedError type: string error_code: enum: - 1003 type: number message: example: You are not authorized to perform this request. type: string statusCode: enum: - 401 type: number required: - statusCode - error - error_code - message type: object ForbiddenError: additionalProperties: false properties: error: enum: - ForbiddenError type: string error_code: enum: - 1004 type: number message: example: You do not have access to this resource. type: string statusCode: enum: - 403 type: number required: - statusCode - error - error_code - message type: object TenantNotFoundError: additionalProperties: false properties: error: enum: - TenantNotFoundError type: string error_code: enum: - 1062 type: number message: example: Tenant not found. type: string statusCode: enum: - 404 type: number required: - statusCode - error - error_code - message type: object UnknownError: additionalProperties: false properties: error: enum: - UnknownError type: string error_code: enum: - 5999 type: number message: example: For some unknown reason your request has not succeeded. type: string statusCode: enum: - 500 type: number required: - statusCode - error - error_code - message type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.