---
title: "Read Answerrules for a User"
method: GET
path: "/domains/{domain}/users/{user}/answerrules"
tags: ["Answer Rules"]
---

# Read Answerrules for a User

`GET /domains/{domain}/users/{user}/answerrules`

## Path parameters

- `domain` string, required — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.
- `user` string, required — This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

## Response `200`

- Answerrule[]
  - `domain` string, required — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\*).
  - `user` string, required — This is the main user extension for the user account.
  - `time-frame` string, required — This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules.
  - `enabled` 'yes' | 'no', required
  - `is-active` boolean, required — This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes.
  - `order` integer — This is to allow for a priority based order of different timeframes. The default is to add it in value higher (lower priority) than the lowest priority timeframe. Timeframe * will get 99 if not already set.
  - `simultaneous-ring` AnswerruleFeatureSimRing
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `do-not-disturb` object — When enabled this feature will block all inbound ringing and send the call to voicemails if enabled.
    - `enabled` 'yes' | 'no', required
  - `forward-always` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-on-active` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-on-busy` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-no-answer` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-when-unregistered` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-on-dnd` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `forward-on-spam-call` AnswerruleFeature
    - `enabled` 'yes' | 'no', required
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `call-screening` object — When enabled this feature will enable the call screening application asking the caller to record their name before attempting the connection based on other answer rules.
    - `enabled` 'yes' | 'no', required
  - `phone-numbers-to-allow` AnswerruleFeatureWithRemove
    - `enabled` 'yes' | 'no'
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `new-position` 'top' | 'bottom' — This will move the answerrule to the top or bottom in the priority list. Top having the most priority, and bottom having the least priority
  - `phone-numbers-to-reject` AnswerruleFeatureWithRemove
    - `enabled` 'yes' | 'no'
    - `parameters` union[] — This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.
      - union
        - string
        - number
  - `time_range_data` Timeframe[]
    - `time-frame` string, required — This is the main timeframe name that will be used as the name and will be used in conjuction with answer rules.
    - `domain` string, required — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\*).
    - `user` string, required — This is the main user extension for the user account.
    - `time-range-data` Timerange[], required — This is an array of time range objects that will make up the timeframe.
      - `ordinal-order` integer — This will be a unique index and orger for the specific timerange inside of the given timeframe.
      - `start-date` string, date — This is field will be set for the start of a calender based time range in the format of YYYY-MM-DD. To disable the start of a range use "now".
      - `end-date` string, date — This is field will be set for the end of a calender based time range in the format of YYYY-MM-DD. To disable the start of a range use "never".
      - `day-of-week-number` union, required — This is field will be set for a specific day of the week ( 0-6 / Sunday - Saturday) for this given time range. * would be used for all days of the week.
        - integer — Integer can be used 0-6 for day in week.
        - string — String of * can be used for all days.
      - `start-time` string, time — This is the time in HH:MM format for the given time range. This will be the start of the window and will be based on the user's time-zone.
      - `end-time` string, time — This is the time in HH:MM format for the given time range. This will be the end of the window and will be based on the user's time-zone.
      - `invert-match` 'yes' | 'no'

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.net/ns-api/apis/netsapiens-api-v2.md) · [All operations](https://skmtc.net/ns-api/apis/netsapiens-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ns-api/netsapiens-api-v2/revisions/d37f65b5b886/schema)