List agents
idx_list_agentsAgents on a multi-user IDX Broker account (id, name, office, contact details, category, language, login dates). Filter by one field or by a time window. GET /clients/agents.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Only return these fields (IDX `rf`); ["*"] returns every available field. Narrow it to save API size. | |
| interval | No | Hours of data to return, counted back from start_datetime (default: now). 0.0166 (one minute) to 8765; decimals allowed. | |
| date_type | No | Which date the time window applies to. | |
| filter_field | No | Field to filter on; needs filter_value. | |
| filter_value | No | Value to match in filter_field. | |
| start_datetime | No | Where the interval starts counting back (the newest moment wanted). Default: now. ISO 8601 with a timezone. |