Broker teams. Each is owned by exactly one broker.
List team chat conversations
The team chat conversations that the broker your key acts as is in: two-person conversations and groups, the newest message first. A conversation the broker is not in is never listed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 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_idUse 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.
List team chat conversations › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Start a team chat conversation
With one teammate in user_ids, opens the conversation with them. If the broker already has one, you get that conversation. With two or more, or with a title, starts a new group. Each teammate must be in GET /v1/direct-threads/roster.
Headers
Idempotency-KeyOptional 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.
Start a team chat conversation › Request Body
user_idsThe teammates to talk to. One teammate opens your conversation with them, or returns the one you already have. Two or more start a new group. Get them from GET /v1/direct-threads/roster.
titleThe name of a group, at most 80 characters. A title always starts a group.
Start a team chat conversation › Responses
Success
successAlways true on a successful response.
The requested record.
List the teammates you can message
The people the broker can start a conversation with: the active members of each team the broker is on. It is the same list as the team chat in BrokerPlus. Not paged.
List the teammates you can message › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
List the messages in a conversation
The messages in a team chat conversation, newest first. Reading them does not mark them read.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List the messages in a conversation › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Send a message to a conversation
Posts a message from the broker your key acts as. The other members see it in their team chat at once. A team chat message stays inside the brokerage: it never goes to a client. Supports Idempotency-Key.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional 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.
Send a message to a conversation › Request Body
bodyThe message. Plain text or HTML, at most 4000 characters of text. Unsafe HTML is removed. The result must contain visible content.
Send a message to a conversation › Responses
Success
successAlways true on a successful response.
The requested record.
Mark a conversation read
Marks every message in the conversation read for the broker your key acts as. The other members see how far the broker has read.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional 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.
Mark a conversation read › Responses
Success
successAlways true on a successful response.
The requested record.
List teams
The broker teams in this brokerage. Every team is owned by exactly one broker.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List teams › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
List a team's members
Who works this team and as what. The owner is the broker; everyone else is a member with the brokerage's own title. People who have left are excluded unless you ask for them.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
include_inactiveSend true to include people who have left the team.
List a team's members › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Read a team's shared note
The note that every member of the team sees and edits on their overview. Only a member of the team can read it.
path Parameters
idResource id.
Read a team's shared note › Responses
Success
successAlways true on a successful response.
The requested record.
Replace a team's shared note
Replaces the whole note. Every member of the team sees the change on their overview. Nobody is notified, and a mention in the note does not notify the teammate. Only a member of the team can change it.
path Parameters
idResource id.
Replace a team's shared note › Request Body
bodyThe whole note. It replaces the note. Plain text or HTML, up to 50,000 characters. Unsafe HTML is removed. Send an empty string to clear the note. A mention in the note does not notify the teammate.
Replace a team's shared note › Responses
Success
successAlways true on a successful response.
The requested record.