Inquirly
  1. Contacts
Inquirly
  • Accounts
    • Create an Account
      POST
    • Get an account details
      GET
    • Update an account
      PATCH
    • Delete an Account
      DELETE
  • Account Users
    • List all Account Users
      GET
    • Create an Account User
      POST
    • Delete an Account User
      DELETE
  • AgentBots
    • List all AgentBots
      GET
    • Create an Agent Bot
      POST
    • Get an agent bot details
      GET
    • Update an agent bot
      PATCH
    • Delete an AgentBot
      DELETE
  • Users
    • Create a User
      POST
    • Get an user details
      GET
    • Update a user
      PATCH
    • Delete a User
      DELETE
    • Get User SSO Link
      GET
  • Inbox API
    • Inbox details
  • Contacts API
    • Create a contact
    • Get a contact
    • Update a contact
  • Conversations API
    • Create a conversation
    • List all conversations
    • Get a single conversation
    • Resolve a conversation
    • Toggle typing status
    • Update last seen
  • Messages API
    • Create a message
    • List all messages
    • Update a message
  • Contact Labels
    • List Labels
    • Add Labels
  • CSAT Survey Page
    • Get CSAT survey page
  • Account AgentBots
    • List all AgentBots
    • Create an Agent Bot
    • Get an agent bot details
    • Update an agent bot
    • Delete an AgentBot
  • Agents
    • List Agents in Account
    • Add a New Agent
    • Update Agent in Account
    • Remove an Agent from Account
  • Canned Responses
    • List all Canned Responses in an Account
    • Add a New Canned Response
    • Remove a Canned Response from Account
  • Canned Response
    • Update Canned Response in Account
  • Custom Attributes
    • List all custom attributes in an account
    • Add a new custom attribute
    • Get a custom attribute details
    • Update custom attribute in Account
    • Remove a custom attribute from account
  • Contacts
    • List Contacts
      GET
    • Create Contact
      POST
    • Show Contact
      GET
    • Update Contact
      PUT
    • Delete Contact
      DELETE
    • Contact Conversations
      GET
    • Search Contacts
      GET
    • Contact Filter
      POST
  • Contact
    • Create contact inbox
    • Get Contactable Inboxes
  • Automation Rule
    • List all automation rules in an account
    • Add a new automation rule
    • Get a automation rule details
    • Update automation rule in Account
    • Remove a automation rule from account
  • Help Center
    • Add a new portal
    • List all portals in an account
    • update a new portal
    • Add a new category
    • Add a new article
  • Conversations
    • Get Conversation Counts
    • Conversations List
    • Create New Conversation
    • Conversations Filter
    • Conversation Details
    • Update Conversation
    • Toggle Status
    • Toggle Priority
  • Conversation Assignment
    • Assign Conversation
  • Conversation Labels
    • List Labels
    • Add Labels
  • Inboxes
    • List all inboxes
    • Get an inbox
    • Create an inbox
    • Update Inbox
    • Show Inbox Agent Bot
    • Add or remove agent bot
    • List Agents in Inbox
    • Add a New Agent
    • Update Agents in Inbox
    • Remove an Agent from Inbox
  • Messages
    • Get messages
    • Create New Message
    • Delete a message
  • Integrations
    • List all the Integrations
    • Create an integration hook
    • Update an Integration Hook
    • Delete an Integration Hook
  • Profile
    • Fetch user profile
  • Teams
    • List all teams
    • Create a team
    • Get a team details
    • Update a team
    • Delete a team
    • List Agents in Team
    • Add a New Agent
    • Update Agents in Team
    • Remove an Agent from Team
  • Custom Filters
    • List all custom filters
    • Create a custom filter
    • Get a custom filter details
    • Update a custom filter
    • Delete a custom filter
  • Webhooks
    • List all webhooks
    • Add a webhook
    • Update a webhook object
    • Delete a webhook
  • Reports
    • Get Account reports
    • Get Account reports summary
    • Account Conversation Metrics
    • Agent Conversation Metrics
  1. Contacts

Search Contacts

GET
/api/v1/accounts/{account_id}/contacts/search
Contacts
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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/accounts//contacts/search'
Response Response Example
200 - Example 1
{
    "payload": [
        {
            "id": 0,
            "payload": {
                "contact": {
                    "email": "string",
                    "name": "string",
                    "phone_number": "string",
                    "thumbnail": "string",
                    "additional_attributes": {},
                    "custom_attributes": {
                        "attribute_key": "attribute_value",
                        "signed_up_at": "dd/mm/yyyy"
                    },
                    "contact_inboxes": [
                        {
                            "source_id": "string",
                            "inbox": {
                                "id": 0,
                                "name": "string",
                                "website_url": "string",
                                "channel_type": "string",
                                "avatar_url": "string",
                                "widget_color": "string",
                                "website_token": "string",
                                "enable_auto_assignment": true,
                                "web_widget_script": "string",
                                "welcome_title": "string",
                                "welcome_tagline": "string",
                                "greeting_enabled": true,
                                "greeting_message": "string"
                            }
                        }
                    ]
                }
            }
        }
    ]
}

Request

Path Params
account_id
integer 
required
The numeric ID of the account
Query Params
q
string 
optional
Search using contact name, identifier, email or phone number
sort
enum<string> 
optional
The attribute by which list should be sorted
Allowed values:
nameemailphone_numberlast_activity_at-name-email-phone_number-last_activity_at
page
integer 
optional
The page parameter
Default:
1

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
payload
array[object (contact) {2}] 
optional
array of contacts
id
number 
optional
payload
object 
optional
🟠401Unauthorized
Previous
Contact Conversations
Next
Contact Filter
Built with