To let an assistant use these tools, grant Organisation on the consent screen, or just
Organisation under its Fine-tune. The scope is organisation.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
Your organisation itself: profile, milestones reached, settings (only owners can change them; settings a platform admin has locked are read-only), members and roles, invites, API applications (their details but never their secrets; an owner can rename one or change its scopes and allowed origins) and the organisation's API logs. Only an owner can create, rotate or delete API credentials, in the dashboard.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
get_organisation
Read Get the organisation
The org's profile; managers also see estate counts (members, API apps, logs, sites).
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_milestones
Read List milestones
What the org has achieved so far: each "first time" it has reached (first WhatsApp conversation, first policy sold, first lead won) with when, the acting person's own firsts (first app sign-in, first win), and the firsts still to come. Firsts from before milestones existed show as reached but not celebrated.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_organisation
Write Rename the organisation
Rename the org (owner-only).
Arguments
| Field | Type | Description |
|---|---|---|
| name required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_org_settings
Read List org settings
Self-service org settings with effective values (owner-only). locked settings are admin-managed and read-only here.
Arguments
| Field | Type | Description |
|---|---|---|
| group | string | general, channels, voice, payments, spending or quoting |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_org_setting
Write Update an org setting
Set one org setting (owner-only). Pass the value typed: booleans for toggles, arrays for domain/channel lists, {day: {start, end}} for business hours. Admin-locked settings are refused; Direct Debit and From-address preconditions apply.
Arguments
| Field | Type | Description |
|---|---|---|
| key required | string | |
| value required | any | Typed per the setting's field_type |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_org_members
Read List members
Active members of the org with their roles.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_org_member_role
Write Change a member's role
Change a member's role (owner-only).
Arguments
| Field | Type | Description |
|---|---|---|
| membership_id required | string | |
| role required | string |
One of: "owner", "manager", "user"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
remove_org_member
Write Remove a member
Remove a member from the org (managers; anyone may remove themselves). Confirm with the operator first.
Arguments
| Field | Type | Description |
|---|---|---|
| membership_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_org_invites
Read List pending invites
Pending invites, the org's allowed email domains, and advisors asking to join from the nurture widget (approve_advisor_request / decline_advisor_request).
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_org_invite
Write Invite someone
Send an invitation to join the org: by email, or by SMS when a phone number is given instead (allowed-domain rules apply to email).
Arguments
| Field | Type | Description |
|---|---|---|
| string | ||
| phone | string | Mobile number for an SMS invite: use instead of email |
| role | string |
Default user
One of: "owner", "manager", "user"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
revoke_org_invite
Write Revoke an invite
Revoke a pending invite.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
approve_advisor_request
Write Approve an advisor's request to join
Invites the advisor (or links them straight to an existing member with that email). Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| request_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
decline_advisor_request
Write Decline an advisor's request to join
The advisor can ask again later. Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| request_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_api_applications
Read List partner API apps
The org's partner API applications. Existing secrets are never returned.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_api_application
Read Get a partner API app
Get one partner API application's non-secret metadata.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string or integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_api_application
Write Update a partner API app
Renames a partner API application or changes its scopes or allowed origins (owners only); only the fields given change. The client secret is unchanged and never returned. Removing a scope revokes its current tokens. An application with allowed origins is a browser one and may only have read and write: crm and outcomes reach customer records, so they need empty allowed origins. Widening scopes or adding origins changes what the firm's integrations can reach: confirm with the user first.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| name | string | |
| scopes | array of string | Replaces the whole list. read is always included. |
| allowed_origins | array of string | Replaces the whole list; empty means server-only. Websites like https://www.example.com; a page address is cut to its origin. |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_org_api_logs
Read List the org's API logs
The org's inbound API traffic, newest first.
Arguments
| Field | Type | Description |
|---|---|---|
| application_id | string | |
| request_id | string | |
| http_method | string | |
| status_class | string | 2xx, 4xx or 5xx |
| path | string | |
| errors_only | boolean | |
| limit | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_integration_logs
Read List integration logs
Calls between Subcontext and the organisation's connected systems (webhooks, custom integrations, Google Sheets), newest first, with HTTP status and error. Set failed_only to see just the failures; get_integration_log shows one call's request and response. Owners and managers.
Arguments
| Field | Type | Description |
|---|---|---|
| failed_only | boolean | |
| connection_id | string | |
| endpoint_key | string | Only calls to this custom integration endpoint |
| direction | string |
One of: "outbound", "inbound"
|
| status | integer | Only calls that got this HTTP status |
| from | string | Earliest day, YYYY-MM-DD |
| to | string | Latest day, YYYY-MM-DD |
| limit | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_org_api_log
Read Get one org API log
One request in full (bodies truncated) plus related rows sharing its request id.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_org_audit_logs
Read List the org's audit log
Who did what in the org, newest first, 50 per page: sign-ins, membership and invite changes, CRM and outreach actions, conversation takeovers and more. Filter by category, exact event key, user_id, or a from/to date range (YYYY-MM-DD). Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| category | string |
One of: "auth", "org", "membership", "invite", "crm", "outreach", "conversation"
|
| event | string | |
| user_id | string | |
| from | string | |
| to | string | |
| page | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_org_audit_log
Read Get an audit log entry
One audit log entry with its full metadata. Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_external_api_calls
Read List third-party API calls
Calls made to outside services on the org's behalf (Data8 lookups, IRESS market quoting), newest first, 50 per page: adapter, endpoint, status and latency. Filter by adapter, application_id, url fragment, status_class, errors_only, or from/to (YYYY-MM-DD). Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| adapter | string | |
| application_id | string | |
| url | string | |
| status_class | string |
One of: "2xx", "4xx", "5xx", "none"
|
| errors_only | boolean | |
| from | string | |
| to | string | |
| page | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_external_api_call
Read Get a third-party API call
One outside-service call with its request and response bodies (clipped). Manager or owner.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |