> ## Documentation Index > Fetch the complete documentation index at: https://docs.tented.ai/llms.txt > Use this file to discover all available pages before exploring further. # Search contacts by rules > Return the contacts matching a segment rule tree — the same rule DSL used for dynamic lists, blast audiences, and flow rules. Rule trees use camelCase keys (`fieldDefinitionId`, `listId`, `timeWindow`), unlike the rest of the API. Trees may nest at most 5 levels deep and contain at most 100 nodes; `email_step` conditions are rejected here (they are only legal inside flow condition steps). Results can be additionally narrowed with `search` and are paginated. Items do not include `custom_fields` — fetch a single contact for those. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/contacts/search openapi: 3.1.0 info: title: Tented API version: 1.0.0 description: >- The Tented public API: generate, publish, and manage AI-built web pages (tents), and run the email platform — contacts, reusable emails, one-time blasts, and triggered flows. ## Authentication Authenticate every request with a workspace API key: `Authorization: Bearer `. Keys are created in **Workspace Settings → API Keys** and are scoped to a single workspace. ## Asynchronous work Tent generation, bulk creation, and email AI generation return `202 Accepted` immediately. Poll the corresponding status endpoint (`GET /v1/tents/{tentId}`, `GET /v1/bulk-jobs/{bulkJobId}`, `GET /v1/emails/{emailId}/generations/{generationId}`) — no more than every 10 seconds. ## Pagination Email listings use cursor pagination (`cursor`/`next_cursor`). Blast, flow, and member listings use page pagination (`page`/`limit` with a `pagination` object in the response). ## Conventions Request and response fields are snake_case, with two exceptions: analytics query parameters (`tentIdOrAlias`, `daysBack`) and segment rule trees (camelCase keys such as `listId` and `timeWindow`). contact: name: Tented Support email: support@tented.ai servers: - url: https://api.tented.ai description: Production security: - bearerAuth: [] tags: - name: Tents description: >- Create, edit, publish, and manage AI-generated pages, including asset uploads and bulk creation. - name: Analytics description: Traffic analytics for single tents and the whole workspace. - name: Contacts description: >- Batch create, update, and delete contacts. Up to 25 items per request with per-item results. - name: Emails description: >- Reusable email content: AI generation, direct HTML edits, plain-text control, and approval. - name: Email Blasts description: >- One-time sends to an audience: compose, schedule, track engagement, export recipients. - name: Triggered Flows description: >- Multi-step automations that enroll contacts on triggers and move them through a step graph. - name: Contact Imports - name: Contact Fields - name: Contact Lists - name: Email Templates - name: Tent Templates description: >- Reusable, AI-editable tent layouts. Create from HTML or an existing tent, iterate with AI, approve, and clone. Approved tent templates seed new tents. paths: /v1/contacts/search: post: tags: - Contacts summary: Search contacts by rules description: >- Return the contacts matching a segment rule tree — the same rule DSL used for dynamic lists, blast audiences, and flow rules. Rule trees use camelCase keys (`fieldDefinitionId`, `listId`, `timeWindow`), unlike the rest of the API. Trees may nest at most 5 levels deep and contain at most 100 nodes; `email_step` conditions are rejected here (they are only legal inside flow condition steps). Results can be additionally narrowed with `search` and are paginated. Items do not include `custom_fields` — fetch a single contact for those. operationId: search-contacts requestBody: required: true content: application/json: schema: type: object properties: rules: $ref: '#/components/schemas/RuleGroup' description: >- Segment rule tree evaluated against the contact base, e.g. `{"kind": "group", "operator": "and", "conditions": [{"kind": "condition", "source": "contact", "field": "state", "operator": "equals", "value": "CA"}]}`. page: type: integer minimum: 1 default: 1 description: Page number, starting at 1. limit: type: integer minimum: 1 maximum: 100 default: 25 description: Results per page (1–100). search: type: string maxLength: 255 description: >- Case-insensitive substring match against display name, email, phone, company, first name, and last name, applied on top of `rules`. sort: type: string enum: - created_at - updated_at - last_activity_at - display_name - first_name - last_name - normalized_email - original_source default: updated_at description: Sort key. order: type: string enum: - asc - desc default: desc description: Sort direction. required: - rules responses: '200': description: A page of matching contacts. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/Contact' description: Contacts in this page (without `custom_fields`). pagination: $ref: '#/components/schemas/Pagination' required: - items - pagination '400': description: >- Bad request — invalid parameters or an invalid rule tree (unsupported field or operator, missing values, more than 5 nesting levels, or more than 100 nodes). Validation failures include `details.issues` with per-field messages. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized — missing, malformed, revoked, or expired API key. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: RuleGroup: type: object properties: kind: type: string enum: - group description: Set to `group` (default when `conditions` is present). operator: type: string enum: - and - or default: and description: How child conditions combine. conditions: type: array items: $ref: '#/components/schemas/RuleNode' description: >- Child nodes. Groups nest up to 5 levels; a tree may contain at most 100 nodes. required: - conditions Contact: type: object properties: contact_id: type: string format: uuid description: Contact ID. display_name: type: - string - 'null' description: Display name. first_name: type: - string - 'null' description: First name. last_name: type: - string - 'null' description: Last name. email: type: - string - 'null' description: Email address. phone: type: - string - 'null' description: Phone number. email_domain: type: - string - 'null' description: Domain derived from the email address. company: type: - string - 'null' description: Company. job_title: type: - string - 'null' description: Job title. address: type: - string - 'null' description: Street address. address2: type: - string - 'null' description: Address line 2. city: type: - string - 'null' description: City. state: type: - string - 'null' description: State or region. country: type: - string - 'null' description: Country. zip_code: type: - string - 'null' description: Postal code. original_source: type: - string - 'null' description: How the contact was first created, e.g. `Public API`. original_source_detail: type: - string - 'null' description: Additional source detail. lead_status: type: - string - 'null' description: Lead status. lifecycle_stage: type: - string - 'null' description: Lifecycle stage. tented_score: type: - number - 'null' description: Contact score. unsubscribed: type: boolean description: Global unsubscribe flag. marketing_email_subscribed: type: - boolean - 'null' description: Email marketing subscription state. marketing_sms_subscribed: type: - boolean - 'null' description: SMS marketing subscription state. marketing_email_invalid: type: boolean description: Whether the email address is known to be invalid. marketing_sms_invalid: type: boolean description: Whether the phone number is known to be invalid. last_activity_at: type: - string - 'null' format: date-time description: Most recent tracked activity. created_at: type: string format: date-time description: Creation time. updated_at: type: string format: date-time description: Last update. description: A contact record. Fields that were never set are omitted. Pagination: type: object properties: page: type: integer description: Current page (1-based). limit: type: integer description: Page size. total: type: integer description: Total matching records. totalPages: type: integer description: Total number of pages. description: Offset pagination metadata. Error: type: object properties: error: type: string description: Human-readable error message. error_code: type: string description: >- Stable machine-readable error code (present on email, blast, flow, and related endpoints, e.g. `campaign_not_ready`, `generation_in_progress`). message: type: string description: Additional human-readable context (present on some tent endpoints). code: type: string description: >- Machine-readable code used by tent creation errors (e.g. `INVALID_PROMPT_INTENT`). details: type: object additionalProperties: true description: >- Additional error context. Validation errors include `issues`: an array of `{ path, message }` objects. limit: type: integer description: Plan limit that was hit (present on `429` publish-limit errors). current: type: integer description: >- Current usage against the limit (present on `429` publish-limit errors). required: - error description: >- Error response. All errors include `error`; the other fields vary by endpoint group. RuleNode: oneOf: - $ref: '#/components/schemas/RuleGroup' - $ref: '#/components/schemas/RuleCondition' description: >- A rule tree node: either a group of nested conditions or a single condition. NOTE: rule trees use camelCase keys (`listId`, `fieldDefinitionId`, `timeWindow`), unlike the rest of the API. RuleCondition: type: object properties: kind: type: string enum: - condition description: >- Set to `condition` (default when `operator` is present without `conditions`). source: type: string enum: - contact - custom_field - activity - list_membership - email_step default: contact description: What the condition tests. field: type: string description: >- Standard contact field in camelCase (e.g. `leadStatus`, `tentedScore`, `createdAt`). Used with `source: contact`. fieldDefinitionId: type: string format: uuid description: 'Active custom-field definition ID. Used with `source: custom_field`.' activityType: type: string description: >- Activity type (e.g. `form_submission`). Used with `source: activity`. listId: type: string format: uuid description: 'Static list ID. Used with `source: list_membership`.' nodeId: type: string description: >- `step_id` of an earlier `send_email` step. Used with `source: email_step` (flows only). metric: type: string enum: - sent - delivered - opened - clicked - bounced - unsubscribed description: 'Email engagement metric. Used with `source: email_step`.' operator: type: string description: >- Comparison operator. Strings: `equals`, `not_equals`, `contains`, `not_contains`, `starts_with`, `ends_with`. Numbers/dates: `equals`, `not_equals`, `greater_than`, `greater_than_or_equal`, `less_than`, `less_than_or_equal`. Booleans: `is_true`, `is_false`. Any: `is_empty`, `is_not_empty`. Membership: `is_member`, `is_not_member`. Activity: `has_activity`, `has_no_activity`. Shorthand aliases (`eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `member_of`) are accepted. value: description: Comparison value, when the operator takes one. timeWindow: type: object properties: amount: type: integer minimum: 1 maximum: 1000 description: Window size. unit: type: string enum: - hour - day - week - month - year description: Window unit. description: Optional look-back window for activity conditions. required: - operator securitySchemes: bearerAuth: type: http scheme: bearer description: >- Workspace API key, e.g. `Authorization: Bearer tented_...`. Create keys in Workspace Settings → API Keys. ````