> ## Documentation Index > Fetch the complete documentation index at: https://docs.tied.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/accounts/{account_id}/contacts/search openapi: 3.0.4 info: title: Tied API description: >- The Tied REST API. Three families of endpoint, each with its own credential: **Application** for everything inside an account, **Platform** for provisioning accounts and users, and **Client** for acting as a contact from your own surface. version: 1.1.0 termsOfService: https://tied.com/legal contact: email: hello@tied.com license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://app.tied.com description: Tied cloud security: [] tags: - name: Account AgentBots description: Account-specific Agent Bots - name: Agents description: Agent management APIs - name: Canned Responses description: Pre-defined responses for common queries - name: Contacts description: Contact management APIs - name: Contact Labels description: Manage contact labels - name: Conversation Assignments description: Manage conversation assignments - name: Conversation Labels description: Manage conversation labels - name: Conversations description: Conversation management APIs - name: Custom Attributes description: Custom fields for contacts and conversations - name: Custom Filters description: Saved filters for conversations - name: Inboxes description: Communication channels setup - name: Integrations description: Third-party integrations - name: Messages description: Message management APIs - name: Profile description: User profile APIs - name: Reports description: Analytics and reporting APIs - name: Teams description: Team management APIs - name: Webhooks description: Event notification webhooks - name: Automation Rule description: Workflow automation rules - name: Help Center description: Knowledge base management - name: Contacts API description: Public contact APIs - name: Conversations API description: Public conversation APIs - name: Messages API description: Public message APIs - name: CSAT Survey Page description: Customer satisfaction survey - name: Account description: >- The authenticated user's own account — read and update account settings. Distinct from the Platform family's **Accounts**, which provisions accounts across an installation. - name: Audit Logs description: Read the account's audit trail - name: Inbox API description: Public inbox lookup by channel identifier - name: Labels description: >- Create and manage the account's labels. Applying one to a conversation or contact is a separate endpoint under those resources. - name: Macros description: >- Saved multi-step actions an agent — or an integration — can run against one or more conversations. - name: Campaigns description: Ongoing website campaigns and one-off SMS and WhatsApp sends. - name: Contact Notes description: Internal notes on a contact. Never visible to the contact. - name: Help Center Categories description: Categories group a portal's articles, one tree per allowed locale. - name: Help Center Articles description: The articles a portal publishes, and their draft and archived states. - name: Summary Reports description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON. - name: Live Reports description: Right-now queue counts. No date range — these describe the present. - name: CSAT description: >- The satisfaction ratings contacts have submitted, and the metrics computed from them. - name: Notifications description: >- The per-user notification feed, its read and snooze state, and the settings that decide what lands in it. - name: Conversation Participants description: >- The agents watching a conversation. Participants get notified about it without being assigned to it. - name: Draft Messages description: >- The unsent reply held for a conversation. Stored in Redis, one per conversation. - name: Search description: >- One search service across conversations, contacts, messages and Help Center articles. - name: Dashboard Apps description: Embedded pages that appear as a tab beside a conversation. - name: Assignment Policies description: How conversations are handed out, and which inbox uses which policy. - name: Files description: Storing a file so another endpoint can attach it. - name: Bot Flows description: >- Scripted conversation flows, their versions, and the publish and rollback that move between them. - name: Billing description: >- Credit balance, usage, invoices, spend controls and the provider-hosted payment flows. - name: AMB Templates description: >- Saved Apple Messages primitive payloads an agent can reuse from the composer. - name: AMB Onboarding description: The in-flight Apple Messages for Business registration for an account. - name: Widget Session description: Starting a widget session and reading the visitor it belongs to. - name: Widget Conversation description: The visitor's conversation and its messages. - name: Widget Context description: Campaigns, agents, labels, events and uploads for a widget session. - name: CSAT Survey description: The public, unauthenticated survey a contact answers from a link. - name: Workspace description: Scheduling and cancelling deletion of the whole workspace. paths: /api/v1/accounts/{account_id}/contacts/search: get: tags: - Contacts summary: Search Contacts 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 operationId: contactSearch parameters: - $ref: '#/components/parameters/account_id' - name: q in: query schema: type: string description: Search using contact `name`, `identifier`, `email` or `phone number` - $ref: '#/components/parameters/contact_sort_param' - $ref: '#/components/parameters/page' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/contacts_list_response' example: meta: count: 1 current_page: 1 payload: - additional_attributes: city: San Francisco country: United States location: San Francisco, United States description: >- Head of Customer Experience at Northwind Supply. Migrating off a legacy helpdesk and launching on Apple Messages first. Prefers async follow-up. company_name: Northwind Supply Co. country_code: US created_at_ip: 203.0.113.10 updated_at_ip: 203.0.113.10 avatar_url_hash: '0000000000000000000000000000000000000000' social_profiles: github: mokonkwo tiktok: northwindsupply twitter: mayabuildscx facebook: northwindsupply linkedin: maya-okonkwo instagram: northwind.supply last_avatar_sync_at: '2026-09-21T02:21:05Z' social_telegram_user_name: maya_okonkwo availability_status: offline email: maya@northwindsupply.com id: 135 name: Maya Okonkwo phone_number: '+14155550198' blocked: false identifier: in_example thumbnail: >- https://app.tied.com/rails/active_storage/blobs/proxy/EXAMPLE/avatar.png thumbnail_background_color: null domain_logo_avatar: false customer_verified: true custom_attributes: plan_tier: Premium lead_source: Apple Messages — pricing page profile_url: https://tied.com/customers/northwind-supply customer_since: '2024-03-15' lifetime_value: '48500' loyalty_discount: '12' newsletter_opt_in: true satisfaction_score: '92' last_activity_at: 1789957263 created_at: 1789957262 contact_inboxes: - source_id: sr_example inbox: id: 1 avatar_url: >- https://app.tied.com/rails/active_storage/blobs/proxy/EXAMPLE/avatar.png channel_id: 1 name: Apple Messages channel_type: Channel::Amb provider: null '401': description: >- Unauthorized. A token that is present but invalid returns this shape; a request with no `api_access_token` header at all returns `{"errors": ["You need to sign in or sign up before continuing."]}`. content: application/json: schema: $ref: '#/components/schemas/error_message' security: - userApiKey: [] components: parameters: account_id: in: path name: id schema: type: integer required: true description: The numeric ID of the account contact_sort_param: in: query name: sort schema: type: string enum: - name - email - phone_number - last_activity_at - '-name' - '-email' - '-phone_number' - '-last_activity_at' required: false description: The attribute by which list should be sorted page: in: query name: page schema: type: integer default: 1 required: false description: The page parameter schemas: contacts_list_response: type: object properties: meta: $ref: '#/components/schemas/contact_meta' payload: type: array items: $ref: '#/components/schemas/contact_list_item' description: List of contacts error_message: type: object description: >- The shape returned by `render_unauthorized`, `render_not_found_error` and `render_could_not_create_error`. properties: error: type: string description: A single human-readable message. example: Resource could not be found required: - error contact_meta: type: object properties: count: type: integer description: Total number of contacts current_page: oneOf: - type: integer - type: string example: 1 description: >- The page this response represents. Echoed verbatim from the `page` query parameter, so it is a **string** when you pass `page` and the integer `1` when you omit it. contact_list_item: type: object properties: additional_attributes: type: object description: The object containing additional attributes related to the contact properties: city: type: string description: City of the contact country: type: string description: Country of the contact country_code: type: string description: Country code of the contact created_at_ip: type: string description: IP address when the contact was created availability_status: type: string description: Availability status of the contact enum: - online - offline email: type: string description: The email address of the contact nullable: true id: type: integer description: The ID of the contact name: type: string description: The name of the contact phone_number: type: string description: The phone number of the contact nullable: true blocked: type: boolean description: Whether the contact is blocked identifier: type: string description: The identifier of the contact nullable: true thumbnail: type: string description: The thumbnail of the contact custom_attributes: type: object description: The custom attributes of the contact last_activity_at: type: integer description: Timestamp of last activity nullable: true created_at: type: integer description: Timestamp when contact was created contact_inboxes: type: array description: List of inboxes associated with this contact items: $ref: '#/components/schemas/contact_inbox' contact_inbox: type: object properties: source_id: type: string description: Source identifier for the contact inbox inbox: type: object properties: id: type: integer description: ID of the inbox avatar_url: type: string description: URL for the inbox avatar channel_id: type: integer description: ID of the channel name: type: string description: Name of the inbox channel_type: type: string description: Type of channel provider: type: string description: Provider of the inbox nullable: true description: The inbox this channel identity belongs to. securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.