Skip to main content
GET
/
api
/
work-tasks
/
filter-options
Get work task filter options
curl --request GET \
  --url https://dev.exante.app/api/work-tasks/filter-options \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "status_code": 200,
  "message": "<string>",
  "data": {
    "type": [
      "task",
      "hil_approval"
    ],
    "status": [
      "todo",
      "in_progress",
      "in_review",
      "done",
      "canceled"
    ],
    "priority": [
      "urgent",
      "high",
      "medium",
      "low"
    ],
    "assign_to_type": [
      "user",
      "agent"
    ],
    "users": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "avatar_url": "<string>"
      }
    ],
    "agents": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}
Returns available values for building filter controls in the UI. Use this to populate dropdowns and multi-selects on your task dashboard.

​
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.

​
Response

{
  "status": "success",
  "status_code": 200,
  "message": "Filter options retrieved",
  "data": {
    "type": ["task", "hil_approval"],
    "status": ["todo", "in_progress", "in_review", "done", "canceled"],
    "priority": ["urgent", "high", "medium", "low"],
    "assign_to_type": ["user", "agent"],
    "users": [
      {
        "uid": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Jane Smith",
        "avatar_url": "https://cdn.example.com/avatars/jane.jpg"
      },
      {
        "uid": "660e8400-e29b-41d4-a716-446655440000",
        "name": "John Doe",
        "avatar_url": "https://cdn.example.com/avatars/john.jpg"
      }
    ],
    "agents": []
  }
}

​
Response fields

FieldTypeDescription
typestring[]Available task types for the type filter
statusstring[]Available statuses for the status filter
prioritystring[]Available priorities for the priority filter
assign_to_typestring[]Assignee categories (user, agent)
usersobject[]Assignable users with uid, name, and avatar_url
agentsobject[]Assignable agents with uid and name
Use the users list to populate assignee dropdowns when creating or updating tasks via the Create or Update endpoints.

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>

Organization to scope options to. Defaults to the user's default organization.

Response

Filter options

​
status
string
Example:

"success"

​
status_code
integer
Example:

200

​
message
string
​
data
object