> ## Documentation Index > Fetch the complete documentation index at: https://docs.reply.io/llms.txt > Use this file to discover all available pages before exploring further. # List contact filter fields > **Coming soon.** This endpoint will be available by early November 2026. _Requires the `contacts:read` scope (or a broader one that includes it)._ List the fields `POST /v3/contacts/filter` accepts in your workspace, with each field's operators, value types and allowed values. Stage names and custom fields are your workspace's own. Fields read from one sequence membership (opened, status in sequence, current step) are listed by `GET /v3/sequences/{id}/contacts/filter/fields` instead. ## OpenAPI ````yaml /api-reference/bundled.yaml get /v3/contacts/filter/fields openapi: 3.1.0 info: version: 3.0.0 title: Reply API description: API for managing email sequences, contacts, and automation workflows servers: - url: https://api.reply.io security: - bearerAuth: [] tags: - name: Contacts description: Manage individual contacts - name: Contact Lists description: Manage contact lists and contact membership - name: Accounts description: Manage accounts (companies/organizations) - name: Account Lists description: Manage account lists and account membership - name: Custom Fields description: Manage custom contact fields - name: Prompt Actions description: Save reusable AI prompts and run them on contacts to fill custom fields - name: Contact Blacklist Rules description: Manage blacklist rules for domains, emails, and email exceptions - name: Live Data description: >- Find new contacts via Live Data searches and read typeahead values for the Live Data / Autopilot filter sidebar - name: Contact Enrichment description: >- Enrich contacts with emails, phone numbers, LinkedIn data, and AI-filled custom fields - name: Email Validations description: Estimate and schedule asynchronous email validation jobs - name: AI SDR Web Search description: Find contacts via AI-driven web search and review past searches - name: Sequences description: Manage email automation sequences - name: Sequence Steps description: Manage individual steps in sequences - name: Sequence Contacts description: Manage contacts within sequences - name: Sequence Folders description: Organize sequences into folders - name: Email Accounts description: Manage email accounts used for sending and receiving - name: Sequence Email Accounts description: Manage email accounts linked to sequences - name: LinkedIn Accounts description: Manage LinkedIn accounts for outreach - name: Sequence LinkedIn Accounts description: Manage LinkedIn accounts linked to sequences - name: Sequence Templates description: Manage sequence templates - name: Email Templates description: Manage email templates and template folders - name: Voices description: Manage cloned voices used for AI voice message steps - name: Schedules description: Manage email send schedules and timing - name: Holiday Calendars description: Manage holiday calendars for scheduling - name: Inbox description: >- Manage inbox threads — list/filter, read state, replies, category assignment, and meeting-intent flagging - name: Inbox Categories description: Manage per-team inbox thread categories and assign threads to them - name: Direct Outreach description: >- Send one-off outreach directly to a contact outside of any sequence — direct emails and LinkedIn connection requests, messages, InMails, and voice messages - name: Tasks description: Manage tasks and to-do items - name: Reports description: >- Generate and access performance reports across email, calls, tasks, LinkedIn, and team performance - name: AI SDR Sequences description: >- Manage AI SDR sequences and their AI SDR-specific settings — create, read settings, partial update, autopilot enable/disable/force-start, approval mode, sequence structure, and playbook/knowledge-base connections - name: AI SDR Sequence Structures description: >- Browse the sequence structures — reusable outlines of AI SDR sequence steps — that can be applied to AI SDR sequences - name: AI SDR Strategist description: Trigger AI Strategist runs - name: AI SDR Playbooks description: >- Manage AI SDR playbooks — tone, voice, and style guides applied during personalized message generation - name: AI SDR Knowledge Bases description: >- Manage AI SDR knowledge bases — collections of documents, links, reply handlers, and reengagement cards that inform the agent's responses - name: AI SDR Offers description: >- Manage AI SDR offers — bundles of company-context inputs (ICP, pain points, value propositions, etc.) used to personalize outreach - name: AI SDR Pending Approvals description: >- Review, send, regenerate, and provide feedback on AI-generated messages awaiting human approval - name: AI SDR Sequence Preview description: >- Read and regenerate per-contact previews of the messages a sequence will send, and provide feedback on preview messages - name: AI SDR Insights description: Read AI SDR insights for sequence contacts - name: AI SDR Intent Signals description: >- Read Reply industry IDs and technology slugs used in AI SDR intent-signal configuration (typeahead) - name: AI Prompts description: >- Manage the AI prompts used to configure sequence steps, and preview the output a prompt produces - name: AI SDR Learnings description: >- Manage the standing rules that shape how the AI writes — list, read, create, partially update and delete AI learnings - name: Registration description: Register the contact that domain purchases are filed under - name: Domains description: Find domains available to buy for outreach - name: Purchased Domains description: >- List the domains your team bought, with their subscription, setup and renewal state - name: Mailboxes description: Add mailboxes to domains your team already bought, priced before you order - name: User Account description: Account information and authentication verification - name: Teams description: Add existing users of your organization to its teams - name: Settings description: Manage team and user settings - name: Billing description: Subscription details and monthly active contacts usage - name: Rate Limits description: Your API rate limits and current usage - name: Webhooks description: Manage webhook subscriptions and inspect delivery history - name: Background Jobs description: >- Track and cancel asynchronous background operations (e.g., email validation) - name: Attachments description: >- Upload file attachments used across email templates, sequence steps, and direct emails paths: /v3/contacts/filter/fields: get: tags: - Contacts summary: List contact filter fields description: >- **Coming soon.** This endpoint will be available by early November 2026. _Requires the `contacts:read` scope (or a broader one that includes it)._ List the fields `POST /v3/contacts/filter` accepts in your workspace, with each field's operators, value types and allowed values. Stage names and custom fields are your workspace's own. Fields read from one sequence membership (opened, status in sequence, current step) are listed by `GET /v3/sequences/{id}/contacts/filter/fields` instead. operationId: GetContactFilterFields responses: '200': description: Filter fields retrieved successfully content: application/json: schema: type: object title: Filter fields description: >- The fields a filter accepts in your workspace, with their operators and values. properties: fields: type: array description: >- Built-in fields first, then your workspace's custom fields. items: type: object title: Filter field description description: A field a filter accepts. properties: field: type: string description: Name to send in a condition's `field`. customFieldKey: type: string description: >- Set on custom fields (`field` is `customFields`). The key to send in `customFieldKey`. label: type: string description: Display name. type: type: string title: Filter field type description: Value type of a filter field. enum: - string - integer - number - boolean - enum - date - reference values: type: array description: >- Allowed values of an enum field. For `stage`, your workspace's stage names. items: type: string references: type: string description: >- For a reference field, the V3 `GET` route under `/v3/` that lists its ids (for example `contact-lists` or `whoami/team-users`). description: type: string description: Notes on how the field is matched. operators: type: array description: >- Operators the field accepts, each with the value it takes. items: type: object title: Filter field operator description: >- An operator a field accepts and the value it takes. properties: operator: type: string title: Filter operator description: >- Comparison a filter condition applies. Matched case-insensitively. All date comparisons are in UTC. `between`, `isToday` and `exactlyDaysAgo` match whole UTC calendar days, starting at 00:00 UTC; `withinLastDays` and `moreThanDaysAgo` count N days back from the current UTC time. enum: - equals - notEquals - in - notIn - contains - notContains - containsAny - containsAll - startsWith - greaterThan - lessThan - isEmpty - isNotEmpty - between - withinLastDays - moreThanDaysAgo - isToday - exactlyDaysAgo valueType: type: string title: Filter value type description: >- Shape of `value` for one operator on a field. Numbers and booleans are JSON values, not strings. - `none`: omit `value` (`isEmpty`, `isNotEmpty`, `isToday`). - `string`: a non-empty string. - `integer`: a whole number: 0 to 36500 days for `withinLastDays`, `moreThanDaysAgo` and `exactlyDaysAgo`, an id of 1 or more on a `reference` field, otherwise 0 or more. - `number`: a number, whole or decimal. - `boolean`: `true` or `false`. - `enum`: one of the field's `values`, case-insensitive. - `dateRange`: `{"from": "yyyy-MM-dd", "to": "yyyy-MM-dd"}` for `between`, both days inclusive, `from` not after `to`. - `stringList`, `integerList`, `numberList`, `enumList`: an array of 1 to 200 items of that type. enum: - none - string - stringList - integer - integerList - number - numberList - boolean - enum - enumList - dateRange andOperators: type: array description: >- Operators an `and` list on this field can use as branches. Empty when the field takes no `and` list. items: type: string title: Filter operator description: >- Comparison a filter condition applies. Matched case-insensitively. All date comparisons are in UTC. `between`, `isToday` and `exactlyDaysAgo` match whole UTC calendar days, starting at 00:00 UTC; `withinLastDays` and `moreThanDaysAgo` count N days back from the current UTC time. enum: - equals - notEquals - in - notIn - contains - notContains - containsAny - containsAll - startsWith - greaterThan - lessThan - isEmpty - isNotEmpty - between - withinLastDays - moreThanDaysAgo - isToday - exactlyDaysAgo orOperators: type: array description: >- Operators an `or` list on this field can use as branches. Empty when the field takes no `or` list. items: type: string title: Filter operator description: >- Comparison a filter condition applies. Matched case-insensitively. All date comparisons are in UTC. `between`, `isToday` and `exactlyDaysAgo` match whole UTC calendar days, starting at 00:00 UTC; `withinLastDays` and `moreThanDaysAgo` count N days back from the current UTC time. enum: - equals - notEquals - in - notIn - contains - notContains - containsAny - containsAll - startsWith - greaterThan - lessThan - isEmpty - isNotEmpty - between - withinLastDays - moreThanDaysAgo - isToday - exactlyDaysAgo example: fields: - field: title label: Title type: string operators: - operator: equals valueType: string - operator: notEquals valueType: string - operator: in valueType: stringList - operator: notIn valueType: stringList - operator: contains valueType: string - operator: notContains valueType: string - operator: containsAny valueType: stringList - operator: containsAll valueType: stringList - operator: startsWith valueType: string - operator: isEmpty valueType: none - operator: isNotEmpty valueType: none andOperators: - equals - notEquals - notIn - contains - notContains - containsAll - isEmpty - isNotEmpty orOperators: - equals - notEquals - in - contains - notContains - containsAny - startsWith - isEmpty - isNotEmpty - field: stage label: Stage type: enum values: - New - Interested - Not interested description: Stage name, case-insensitive. operators: - operator: equals valueType: enum - operator: notEquals valueType: enum - operator: in valueType: enumList - operator: notIn valueType: enumList - operator: isEmpty valueType: none - operator: isNotEmpty valueType: none andOperators: - equals - notEquals - notIn - isEmpty - isNotEmpty orOperators: - equals - notEquals - in - isEmpty - isNotEmpty - field: customFields customFieldKey: '12' label: Deal size type: number operators: - operator: equals valueType: number - operator: notEquals valueType: number - operator: greaterThan valueType: number - operator: lessThan valueType: number - operator: isEmpty valueType: none - operator: isNotEmpty valueType: none andOperators: [] orOperators: - equals - notEquals - greaterThan - lessThan - isEmpty - isNotEmpty '401': description: >- Unauthorized. The response body is empty; check the `WWW-Authenticate` header for the expected scheme. content: application/problem+json: schema: allOf: - type: object title: Problem Details description: >- Bare RFC 9457 problem-details envelope. Returned by middleware-level errors that don't carry domain context: 401 Unauthorized (auth middleware), 429 Too Many Requests (rate-limit middleware), and route-level 404 / 405 / 415 (framework middleware). Business and validation responses extend this envelope and add additional fields — see `business-problem.model.yaml` (adds `code` slug) and `validation-problem.model.yaml` (adds `errors[]` array). properties: title: type: string description: Short, human-readable summary of the problem. status: type: integer description: HTTP status code. minimum: 100 maximum: 599 detail: type: string description: >- Human-readable explanation specific to this occurrence. - example: title: Unauthorized status: 401 detail: Authentication credentials are missing or invalid. '429': description: Too Many Requests headers: Retry-After: description: Seconds to wait before retrying schema: type: integer minimum: 1 content: application/problem+json: schema: allOf: - type: object title: Problem Details description: >- Bare RFC 9457 problem-details envelope. Returned by middleware-level errors that don't carry domain context: 401 Unauthorized (auth middleware), 429 Too Many Requests (rate-limit middleware), and route-level 404 / 405 / 415 (framework middleware). Business and validation responses extend this envelope and add additional fields — see `business-problem.model.yaml` (adds `code` slug) and `validation-problem.model.yaml` (adds `errors[]` array). properties: title: type: string description: Short, human-readable summary of the problem. status: type: integer description: HTTP status code. minimum: 100 maximum: 599 detail: type: string description: >- Human-readable explanation specific to this occurrence. example: title: Too Many Requests status: 429 detail: API calls quota exceeded! maximum admitted 100 per 1m. components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Authenticate every request with a Bearer token. Pass your Reply API key in the `Authorization` header: ``` Authorization: Bearer ``` Get your API key from the Reply dashboard: **Settings → API Key**. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.