SmsGetAgents¶

GET sms/agents/list

Returns the manager-to-sender links of the brand. Use it to see which managers can send through INDIVIDUAL profiles and which ones would be rejected for having no sender identity.

Access Control¶

Allowed role: admin, within the brand of the caller.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/agents/list?limit=50&where=%7B%22profileId%22%3A5%7D
Authorization: <JWT_TOKEN>

{
  "command": "SmsGetAgents",
  "extID": "1",
  "data": {
    "limit": 50,
    "where": {
      "profileId": 5
    }
  }
}

const res = await platform.SmsGetAgents({
  limit: 50,
  where: {
    profileId: 5
  }
});

Request Data¶

Field	Type	Required	Description
`limit`	int	No	Page size, `1..1000`, default `100`
`offset`	int	No	Rows to skip
`orderBy`	array	No	Sorting, for example `["id", "DESC"]`
`count`	array	No	Row count aggregate, `["id"]`
`where`	object	No	Filters, see Table filter syntax

Response Data¶

{
  "rows": [
    {
      "id": 12,
      "brand": "default",
      "managerId": 10,
      "profileId": 5,
      "externalIdentifier": "ScaleTradeJohn",
      "status": "ENABLED",
      "createdAt": "2026-08-24 13:10:02",
      "updatedAt": null
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Not an admin session