Skip to main content
GET
/
v1
/
agent
/
endpoint
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const agentEndpoints = await client.agentEndpoint.list();

console.log(agentEndpoints.data);
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "PHONE",
      "value": "<string>",
      "environment": "<string>",
      "direction": "INCOMING",
      "outboundDialType": "NONE",
      "outboundDialHttpRequestDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:20

Maximum number of endpoints to return (default: 20, max: 50)

Required range: 1 <= x <= 50
​
after
string

Cursor for pagination - endpoint ID to start after

​
agentId
string<uuid>

Filter by agent ID

​
searchText
string

Search text to filter endpoints

Response

List of agent endpoints

​
data
object[]
required
​
pagination
object
required