Chatwoot/swagger/paths/application/contacts/search.yml

get:
  tags:
    - Contacts
  operationId: contactSearch
  description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
  summary: Search Contacts
  parameters:
    - $ref: '#/parameters/account_id'
    - name: q
      in: query
      type: string
      description: Search using contact `name`, `identifier`, `email` or `phone number`
    - $ref: '#/parameters/contact_sort_param'
    - $ref: '#/parameters/page'
  responses:
    200:
      description: Success
      schema:
        type: object
        properties:
          payload:
            $ref: '#/definitions/contact_list'
    401:
      description: Authentication error
      schema:
        $ref: '#/definitions/bad_request_error'
chore: Update API docs (#1153) 2020-08-18 06:44:37 +00:00			`get:`
			`tags:`
chore: Add Swagger Doc for Team Members (#4390) Add swagger documentation for Team Members APIs 2022-04-05 10:35:49 +00:00			`- Contacts`
chore: Update API docs (#1153) 2020-08-18 06:44:37 +00:00			`operationId: contactSearch`
Chore: API Improvements (#2956) - API to fetch info of a single inbox - Document passing custom_attributes in the API - Ability to filter contacts with contact identifier in search API 2021-09-04 12:26:46 +00:00			`description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number`
chore: Update API docs (#1153) 2020-08-18 06:44:37 +00:00			`summary: Search Contacts`
			`parameters:`
Chore: API Improvements (#2956) - API to fetch info of a single inbox - Document passing custom_attributes in the API - Ability to filter contacts with contact identifier in search API 2021-09-04 12:26:46 +00:00			`- $ref: '#/parameters/account_id'`
chore: Update API docs (#1153) 2020-08-18 06:44:37 +00:00			`- name: q`
			`in: query`
			`type: string`
chore: Ability to create contact with identifiers (#2802) 2021-08-13 07:32:46 +00:00			description: Search using contact `name`, `identifier`, `email` or `phone number`
feat: Sort contacts via name, email, phone_number, last_activity_at (#1870) 2021-05-13 08:02:19 +00:00			`- $ref: '#/parameters/contact_sort_param'`
			`- $ref: '#/parameters/page'`
chore: Update API docs (#1153) 2020-08-18 06:44:37 +00:00			`responses:`
			`200:`
			`description: Success`
			`schema:`
			`type: object`
			`properties:`
			`payload:`
			`$ref: '#/definitions/contact_list'`
			`401:`
			`description: Authentication error`
			`schema:`
			`$ref: '#/definitions/bad_request_error'`