Skip to main content
GET
Retrieve a task

Authorizations

Authorization
string
header
required

An API key of the form mya_…, sent as Authorization: Bearer mya_…. The secret is shown once, when the key is created.

Path Parameters

id
string
required
Minimum string length: 1

Query Parameters

expand
enum<string>[]
Maximum array length: 100

Expandable field. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
deal

Response

OK

A piece of work on a brokerage's deals, and who holds it.

object
any
required
id
string
required
brokerage
string
required
deal
required

The deal id; the whole deal with expand=deal; null for work with no deal.

type
enum<string>
required

Task type. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
address_rejected_tradesheet,
answer_deal_question,
answer_inbound_message,
approve_deal_update,
approve_for_tradesheet_gen,
approve_mutual_release,
approve_tradesheet,
chase_deal_question,
chase_overdue_condition,
confirm_client_payment,
confirm_commission,
confirm_deal_closed,
create_commission_stmt,
create_final_tradesheet,
create_upload_invoice,
create_upload_tradesheet,
materialization_failed,
obtain_client_payment,
obtain_lawyer_info,
process_segment,
process_source_document,
provide_client_payment,
release_deposit_funds,
resolve_new_deal_intent,
review_agent_help_request,
review_agent_message,
review_amendment,
review_condition_resolution,
review_conversation_thread,
review_document_classification,
review_extraction_issues,
review_listing,
review_listing_suspension,
review_listing_cancellation,
approve_listing_update,
review_unclassified_deal,
review_unread_conditions,
review_unsupported_deal_type,
send_initial_checklist,
sign_tradesheet,
upload_agent_payment,
upload_agent_payment_coop,
upload_coop_invoice,
upload_coop_payment,
upload_deposit_receipt,
upload_listing_brokerage_receipt,
upload_vendor_payment
label
string
required
description
string | null
required

What the work is, in words a person can act on. May name clients.

priority
integer
required

A relative queue rank: lower is more urgent. Values may be re-scaled and are comparable only within one brokerage.

Required range: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
required

Task status. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
open,
held,
done,
dismissed
outcome
enum<string> | null
required

Task outcome, read together with the task type. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
abandoned,
accepted_as_is,
answered,
applied,
approved,
bound_to_existing,
bound_to_existing_listing,
chased,
classified,
completed,
corrected,
deal_created,
discarded,
materialized,
nothing_owed,
not_applicable,
not_a_deal,
not_extractable,
no_residual_owed,
rejected,
replied,
returned_for_corrections,
routed_manually,
settled,
superseded,
typed,
unprocessable,
withdrawn
assignee
object
required
assigned_at
string<date-time>
required

When the task reached its current holder. Tasks created before 2026-10-10 carry created_at.

accountable_role
enum<string>
required

Role. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
system_admin,
org_admin,
brokerage_admin,
office_admin,
team_leader,
deal_processor,
closing_processor,
listing_processor,
deal_processor_manager,
agent,
assistant
due_at
string<date-time> | null
required

The due date, when the task has one. No workflow sets one yet, so expect null and use the deal's dates.

created_at
string<date-time>
required
created_by
object
required
resolved_at
string<date-time> | null
required
resolved_by
object
required
url
string
required

Opens the task in the myAbode web app at /go/task/. This path is part of the public contract.

updated_at
string<date-time>
required

Also moves when unpublished fields change, so updated_since can return a task with no visible change.