Skip to main content
GET
/
api
/
invoices
/
outreach
/
filter-options
Get constrained filter options for outreach dashboard
curl --request GET \
  --url https://dev.exante.app/api/invoices/outreach/filter-options \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "status_code": 200,
  "message": "Success",
  "data": {
    "invoice_statuses": [
      "<string>"
    ],
    "email_summary": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "email_delivery_statuses": [
      "<string>"
    ],
    "outbound_email_statuses": [
      "<string>"
    ],
    "initiator_types": [
      "<string>"
    ],
    "customers": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "agents": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "users": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>"
      }
    ],
    "ranges": {
      "amount_due_cents": {
        "min": 123,
        "max": 123
      },
      "contacts_count": {
        "min": 123,
        "max": 123
      }
    },
    "date_ranges": {
      "issue_date": {
        "min": "2023-11-07T05:31:56Z",
        "max": "2023-11-07T05:31:56Z"
      },
      "due_date": {
        "min": "2023-11-07T05:31:56Z",
        "max": "2023-11-07T05:31:56Z"
      },
      "paid_date": {
        "min": "2023-11-07T05:31:56Z",
        "max": "2023-11-07T05:31:56Z"
      },
      "last_contact_at": {
        "min": "2023-11-07T05:31:56Z",
        "max": "2023-11-07T05:31:56Z"
      }
    },
    "sort_fields": [
      "<string>"
    ]
  }
}
Returns constrained values for building outreach filters in the UI.

​
Organization scoping

  • If organization_uid is omitted, the API uses your default organization.
  • If organization_uid is invalid, the API returns 400.
  • If you are not a member of the requested organization, the API returns 403.

​
Designed for frontend controls

  • Multi-select options (invoice_statuses, email_delivery_statuses, outbound_email_statuses)
  • Type-ahead lists (customers, agents, users)
  • Numeric sliders (ranges.amount_due_cents, ranges.contacts_count)
  • Date ranges (date_ranges.issue_date, date_ranges.due_date, date_ranges.paid_date, date_ranges.last_contact_at)
  • Sort options (sort_fields)

​
Type-ahead query params

  • customer_search
  • agent_search
  • user_search
  • limit (default 20, max 100)
You can pass current dashboard filters to receive values constrained to the active dataset. The endpoint accepts the same filter params as GET /api/invoices/outreach, including alias params used by frontend routes such as:
  • customers (maps to customer/party UID filter)
  • agent_id (maps to agent_uid)
  • user_id (maps to user_uid)
  • planned_sent_at_from and planned_sent_at_to (map to planned_send_at_*)
  • last_contact_date_from and last_contact_date_to (map to last_contact_at_*)

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organization_uid
string<uuid>
​
customers
string

Comma-separated customer party UIDs (same semantics as /api/invoices/outreach)

​
customer_uids
string

Alias-equivalent to customers

​
target_party_uids
string

Alias for customer_uids

​
invoice_uid
string<uuid>
​
invoice_number
string
​
target_party_uid
string<uuid>
​
invoice_status
string
​
issue_date_from
string<date-time>
​
issue_date_to
string<date-time>
​
due_date_from
string<date-time>
​
due_date_to
string<date-time>
​
paid_date_from
string<date-time>
​
paid_date_to
string<date-time>
​
amount_due_from
integer
Required range: x >= 0
​
amount_due_to
integer
Required range: x >= 0
​
initiator_type
enum<string>
Available options:
AGENT,
USER
​
agent_uid
string<uuid>
​
agent_id
string<uuid>

Alias for agent_uid

​
agent_name
string
​
user_uid
string<uuid>
​
user_id
string<uuid>

Alias for user_uid

​
user_email
string
​
email_delivery_status
string
​
outbound_email_status
string
​
email_status
string
​
sent_at_from
string<date-time>
​
sent_at_to
string<date-time>
​
planned_send_at_from
string<date-time>
​
planned_send_at_to
string<date-time>
​
planned_sent_at_from
string<date-time>

Alias for planned_send_at_from

​
planned_sent_at_to
string<date-time>

Alias for planned_send_at_to

​
contacts_min
integer
Required range: x >= 0
​
contacts_max
integer
Required range: x >= 0
​
last_contact_at_from
string<date-time>
​
last_contact_at_to
string<date-time>
​
last_contact_date_from
string<date-time>

Alias for last_contact_at_from

​
last_contact_date_to
string<date-time>

Alias for last_contact_at_to

​
customer_search
string

Type-ahead search term for customers (recommended min 2 chars)

​
agent_search
string

Type-ahead search term for agents (recommended min 2 chars)

​
user_search
string

Type-ahead search term for users by email (recommended min 2 chars)

​
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Constrained filter options

​
status
string
Example:

"success"

​
status_code
integer
Example:

200

​
message
string
Example:

"Success"

​
data
object