Assistant

The standing instructions a broker gives their assistant.

List the assistant's instructions

GET

https://api.mos.getbrokerplus.ca/v1

/agent-instructions

The standing instructions the broker gave their assistant, the same list as Assistant settings in BrokerPlus: the brokerage's instructions and the broker's team's, by topic and then oldest first.

List the assistant's instructions › query Parameters

page

integer · min: 1 · max: 1000000

1-indexed page number, up to 1000000.

Default: 1

page_size

integer · min: 1 · max: 100

Rows per page. Capped at 100.

Default: 50

updated_since

string · date-time

ISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.

after_id

string

Use with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.

topic

string · enum

Only the instructions under this topic.

Enum values:

always

client_writing

tasks

stage_moves

documents

lenders

List the assistant's instructions › Responses

Success

success

boolean · required

Always true on a successful response.

object[] · required

The page of results. The endpoint description and the Pagination guide give the order.

object · required

Offset pagination. Page forward until page reaches total_pages.

Give the assistant an instruction

POST

https://api.mos.getbrokerplus.ca/v1

/agent-instructions

Adds a standing instruction that the assistant follows from its next run. A topic holds at most 8 instructions for a team, and 8 for the brokerage.

Give the assistant an instruction › Headers

Idempotency-Key

string · maxLength: 255

Optional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.

Give the assistant an instruction › Request Body

topic

string · enum · required

When the assistant applies the instruction: always (always), client_writing (writing to clients), tasks (assigning tasks), stage_moves (moving deals forward), documents (chasing documents), lenders (dealing with lenders).

Enum values:

always

client_writing

tasks

stage_moves

documents

lenders

body

string · minLength: 1 · maxLength: 2000 · required

The instruction, at most 2000 characters.

scope

string · enum · required

team (the default) for the broker's own team. brokerage for every team: only an admin can.

Enum values:

team

brokerage

Default: team

title

string | null · maxLength: 80

A short name, at most 80 characters.

Give the assistant an instruction › Responses

Success

success

boolean · required

Always true on a successful response.

object · required

The requested record.

POST/agent-instructions

curl https://api.mos.getbrokerplus.ca/v1/agent-instructions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "topic": "always",
  "body": "body",
  "title": "title",
  "scope": "team"
}'

Example Request Body

{
  "topic": "always",
  "body": "body",
  "title": "title",
  "scope": "team"
}

json

Example Responses

{
  "success": true,
  "data": {
    "object": "agent_instruction",
    "id": "id",
    "scope": "team",
    "team_id": "team_id",
    "topic": "always",
    "title": "title",
    "body": "body",
    "enabled": true,
    "editable": true,
    "created_by_user_id": "created_by_user_id",
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Retrieve an instruction

GET

https://api.mos.getbrokerplus.ca/v1

/agent-instructions/{id}

One standing instruction to the assistant.

Retrieve an instruction › path Parameters

id

string · required

Resource id.

Retrieve an instruction › Responses

Success

success

boolean · required

Always true on a successful response.

object · required

The requested record.

Delete an instruction

DELETE

https://api.mos.getbrokerplus.ca/v1

/agent-instructions/{id}

Deletes the instruction. The assistant stops following it from its next run.

Delete an instruction › path Parameters

id

string · required

Resource id.

Delete an instruction › Responses

Success

success

boolean · required

Always true on a successful response.

object · required

The requested record.

Update an instruction

PATCH

https://api.mos.getbrokerplus.ca/v1

/agent-instructions/{id}

Changes the fields you send. Send enabled: false to switch an instruction off and keep it.

Update an instruction › path Parameters

id

string · required

Resource id.

Update an instruction › Request Body

topic

string · enum

Enum values:

always

client_writing

tasks

stage_moves

documents

lenders

body

string · minLength: 1 · maxLength: 2000

The instruction, at most 2000 characters.

title

string | null · maxLength: 80

A short name, at most 80 characters.

enabled

boolean

False switches the instruction off without deleting it.

Update an instruction › Responses

Success

success

boolean · required

Always true on a successful response.

object · required

The requested record.

PATCH/agent-instructions/{id}

curl https://api.mos.getbrokerplus.ca/v1/agent-instructions/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "topic": "always",
  "body": "body",
  "title": "title",
  "enabled": true
}'

Example Request Body

{
  "topic": "always",
  "body": "body",
  "title": "title",
  "enabled": true
}

json

Example Responses

{
  "success": true,
  "data": {
    "object": "agent_instruction",
    "id": "id",
    "scope": "team",
    "team_id": "team_id",
    "topic": "always",
    "title": "title",
    "body": "body",
    "enabled": true,
    "editable": true,
    "created_by_user_id": "created_by_user_id",
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Identity Users