Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Slate Labs home page

slate-labs.com

Guides

API reference

slate-labs.com

Authentication

POST
User Login
GET
Autologin
POST
Change Password
POST
Refresh Access Token
POST
Setup 2Fa
POST
Verify And Enable 2Fa
POST
Disable 2Fa
POST
Customer 2Fa Login Verify
GET
List Sessions
DEL
Revoke All Other Sessions
DEL
Revoke Session
GET
Admin List User Sessions
DEL
Admin Revoke User Session

Customers

POST
Customer Login
POST
Request Password Reset Authenticated
POST
Forgot Password
GET
Verify Password Reset
POST
Confirm Password Reset
GET
Get Public Branding
POST
Customer Logout
GET
Customer Get Profile
PATCH
Customer Update Profile
GET
Customer List Transactions
GET
Customer List Consents
POST
Customer Accept Consent
GET
List My Trading Accounts
POST
Select Trading Account
POST
Customer Request Withdrawal
GET
Customer Available Gateways
POST
Customer Initiate Deposit
POST
Customer Cancel Withdrawal
GET
Customer Max Withdrawable
POST
Set Customer Password
POST
Customer 2Fa Setup
POST
Customer 2Fa Verify Setup
POST
Customer 2Fa Disable
GET
Customer 2Fa Backup Codes
POST
Customer 2Fa Regenerate Backup
GET
List Customer Notifications
GET
Get Unread Notification Count
PATCH
Mark Notification Read
POST
Mark All Notifications Read
GET
Get Kyc Status
POST
Start Kyc
POST
Customer Submit Support
POST
Create Telegram Link Token
POST
Create Whatsapp Link Token
PATCH
Update Preferred Language
POST
Register Customer
GET
List Customers
GET
Get Customer
PATCH
Update Customer
POST
Create Additional Account
POST
Dedupe Check
POST
Ping Customer
GET
Get Customer Online
GET
List Consents
POST
Record Consent
GET
List Communications
GET
Get Customer Trader Days
POST
Staff Reset Customer Password
POST
Staff Mint Autologin Token
POST
Create Customer Transfer
GET
Import Template
POST
Import Customers Upload
GET
Import Status
GET
Import Rejections
POST
Assign Customers
GET
List Stale Followups
GET
Get Customer Assignment History
GET
Get Current Assignments
GET
List Activities
POST
Create Activity
POST
Create Note
DEL
Delete Note
PATCH
Edit Note
GET
List Note Edits
GET
List Customer Tasks
POST
Create Task
PATCH
Update Task

Users

POST
Admin Force Disable 2Fa
GET
List Users
POST
Create User
GET
Get Me
PATCH
Update Me
GET
Get My Sessions
DEL
Revoke My Session
GET
Get My Integration Settings
PUT
Upsert My Integration Settings
DEL
Delete My Integration Settings
GET
Get User
PATCH
Update User
POST
Ping User
GET
Get User Online
GET
Get User Sessions
DEL
Revoke User Session
GET
Get User Integration Settings
PUT
Upsert User Integration Settings
DEL
Delete User Integration Settings
GET
List Filter Views
POST
Create Filter View
DEL
Delete Filter View
PATCH
Update Filter View
PATCH
Change User Team
GET
Get User Team History

Roles & Teams

GET
List Teams
POST
Create Team
GET
Get Teams Tree
GET
Get Team
PATCH
Update Team
GET
Get Team Children
GET
Get Team Subtree
GET
Get Team Users
GET
Get Team Subtree Users
GET
List Roles
POST
Create Role
GET
Get Role
PATCH
Update Role
GET
List Role Permissions
PUT
Upsert Role Permission
DEL
Remove Role Permission
GET
List Permissions
POST
Create Permission
GET
List Team Permission Overrides
PUT
Upsert Team Permission Override
DEL
Delete Team Permission Override

Accounts

GET
List Accounts
GET
Get Account By Login
GET
Get Account Balance
GET
Get Account Ledger
GET
Get Account Ledger Summary
GET
List Account Transactions
POST
Close Account
GET
List Account Currencies
PATCH
Reassign Account Group
PATCH
Toggle Account Close Only
GET
Account State Snapshot
GET
Account Stream

Reporting

GET
Get Trader Days Summary
GET
Get Trader Days Daily
GET
List Ftd Minimums
POST
Set Ftd Minimum
GET
Current Ftd Minimums
GET
List Ftds
GET
List Ftd Incomplete
GET
Get Customer Ftd Status
GET
Get Retention Rule
PUT
Upsert Retention Rule

Transactions

POST
Create Manual Transaction
POST
Create Cashier Transaction
POST
Payment Callback
PATCH
Approve Transaction
POST
Bulk Approve Transactions
PATCH
Decline Transaction
PATCH
Soft Delete Transaction
GET
List Transactions
GET
Transaction Filter Options
GET
List Pending Approval
GET
Get Transaction
POST
Create Chargeback
GET
List Withdrawal Approval Rules
POST
Create Withdrawal Approval Rule
PUT
Update Withdrawal Approval Rule
DEL
Delete Withdrawal Approval Rule
POST
Create Crm Transfer

Transfers

GET
Get Transfer Preview

Webhooks

POST
Kyc Webhook
POST
Legacy Praxis Webhook
GET
List Webhooks
POST
Create Webhook
GET
Get Webhook
DEL
Delete Webhook
PATCH
Update Webhook
GET
List Deliveries
GET
Delivery Stats

Compliance

GET
List Jurisdictions
POST
Create Jurisdiction
PATCH
Update Jurisdiction
GET
List Compliance Events
GET
List Customer Logins
POST
Freeze Customer
POST
Unfreeze Customer
GET
List Countries
GET
List Country Default Groups
PUT
Upsert Country Default Group
DEL
Delete Country Default Group

Payments

GET
List Available Gateways
GET
List Payment Routing
PUT
Upsert Payment Routing
DEL
Delete Payment Routing
GET
Resolve Payment Gateway
GET
List Country Gateways
PUT
Upsert Country Gateway
GET
Available Gateways For Country
DEL
Delete Country Gateway
POST
Create Bridgerpay Session

Instruments & Groups

GET
List Groups
POST
Create Group
GET
Get Group
DEL
Deactivate Group
PATCH
Update Group
POST
Clone Group
GET
Batch Prices
GET
List Asset Classes
GET
List Instruments
POST
Create Instrument
GET
Get Instrument
GET
List Broker Instruments
GET
List Available Instruments
PATCH
Update Broker Instrument
GET
Group Change Impact
PUT
Upsert Group Instrument
GET
List Group Instruments
PUT
Bulk Swap Config
GET
Get Group Swap Rates

Fraud & moderation

GET
List Disposable Domains
POST
Add Disposable Domain
DEL
Remove Disposable Domain
GET
Get Fraud Log

Promo codes

GET
List Promo Codes
POST
Create Promo Code
GET
Get Promo Code
DEL
Deactivate Promo Code
PATCH
Update Promo Code

Internal

GET
Internal Roles With Permissions
GET
Internal Team Hierarchy
GET
Internal Api Token By Hash
GET
Bi Exchange
GET
Bi Validate

BI

POST
Sso Token

API Tokens

GET
List Tokens
POST
Create Token
GET
List Scopes
GET
Get Token
DEL
Revoke Token
PATCH
Update Token
POST
Rotate Token
GET
Token Usage

Observability

GET
Health
GET
Root
GET
Metrics
GET
Price Health
GET
List Price Outages

Simulator

GET
Simulator Config
GET
Simulator Fx Endpoint

Orders

GET
List Orders
POST
Place Order
GET
Get Order Execution Status
GET
List Pending Orders
POST
Place Pending Order
GET
List All Orders
GET
List All Orders Stats
GET
List All Pending Orders
GET
List All History
GET
Get Order
DEL
Close Position
POST
Bulk Close Orders
PATCH
Modify Sltp
DEL
Cancel Pending Order
PATCH
Modify Pending Order
GET
List History
GET
Get History

Audit

GET
List Stopout Events
GET
List Audit Log

Messaging

GET
List Conversations
GET
List Unmatched Conversations
POST
Link Conversation
GET
Get Messages
POST
Send Message
POST
Send Template Message
POST
Start Conversation
POST
Mark Read
GET
Get Templates
GET
Messaging Stream
GET
List Email Placeholders
GET
List Email Templates
POST
Create Email Template
GET
Get Email Template
PUT
Update Email Template
DEL
Delete Email Template
POST
Clone Email Template
PUT
Upsert Translation
DEL
Delete Translation
POST
Preview Email Template
POST
Analyze Sms Text
GET
List Sms Templates
POST
Create Sms Template
GET
Get Sms Template
PUT
Update Sms Template
DEL
Delete Sms Template
POST
Clone Sms Template
PUT
Upsert Sms Translation
DEL
Delete Sms Translation
POST
Preview Sms Template

Workflow & CRM

GET
List Statuses
POST
Create Status
GET
Get Statuses Grouped
GET
Get Status
DEL
Delete Status
PATCH
Update Status
GET
My Tasks
GET
Team Tasks
GET
Unassigned Tasks
GET
List Workflows
POST
Create Workflow
GET
Workflow Stats
GET
List Available Triggers
GET
List Available Fields
GET
List Available Actions
GET
List Available Operators
GET
Get Workflow
PUT
Update Workflow
DEL
Delete Workflow
PATCH
Toggle Workflow
POST
Clone Workflow
GET
Workflow Execution History

Streams (SSE)

GET
Stream Accounts
GET
Stream Orders
GET
Stream Prices
GET
Stream Activity

Broker settings

GET
List Broker Settings
PUT
Upsert Broker Setting
POST
Toggle Maintenance Mode

Risk

GET
List Limits
PUT
Upsert Limit
DEL
Delete Limit
GET
Get Live Exposure
GET
Get Symbol Exposure
GET
Get Symbol Account Concentration
GET
List Alerts
PATCH
Acknowledge Alert
GET
Get Exposure History
GET
Exposure Stream
GET
List Overrides
POST
Revert Override
POST
Freeze Customer
POST
Toggle Close Only
POST
Manual Reassign Group
GET
Get Classification History
GET
List Risk Notifications
GET
Get Risk Rule
PUT
Upsert Risk Rule
GET
Get Risk Rule History
POST
Preview Risk Rule
GET
List Risk Profiles
GET
Get Risk Profile

Integrations

GET
List Catalog
GET
Get Catalog Entry
GET
List Active
GET
Get Active
POST
Activate Integration
POST
Deactivate Integration
PUT
Update Credentials
PUT
Update Config
POST
Test Integration
POST
Execute Action
POST
Execute Action By Slug
POST
Create Payment Session
POST
Create Bridgerpay Session
POST
Create Praxis Session
POST
Create Payretailers Session
GET
Whatsapp Webhook Verify
POST
Receive Webhook
GET
List Audit
POST
Send Email
POST
Send Sms
POST
Initiate Call
POST
Email Delivery Webhook
POST
Sms Delivery Webhook
POST
Call Status Webhook
GET
Get Integration Config

List Stale Followups

curl --request GET \
  --url https://api.{your-broker}.slate-labs.com/customers/stale-followups

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Customers

List Stale Followups

Customers owned by the caller with no recent activity and no open task.

Used by the tasks.html “Suggested follow-ups” panel. Filters to:

customers.owner_id == caller (the caller only sees their own)
last_activity_at older than days days (or NULL → also stale)
NO open customer_tasks row (status pending/in_progress) assigned to caller

Returns stalest first. Empty result returns [] with status 200.

GET

customers

stale-followups

List Stale Followups

curl --request GET \
  --url https://api.{your-broker}.slate-labs.com/customers/stale-followups

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

days

integer

default:14

Required range: 1 <= x <= 365

limit

integer

default:20

Required range: 1 <= x <= 100

Response

Successful Response

Assign Customers Get Customer Assignment History

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform