Skip to main content
GET
/
api
/
v1
/
sip
/
alias
Get aliases for an organization, optionally filtered by agent
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blackbox.dasha.ai/api/v1/sip/alias', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alias": "<string>",
      "agentId": "<string>",
      "createdTime": "2023-11-07T05:31:56Z",
      "lastUpdateTime": "2023-11-07T05:31:56Z",
      "isDefault": true
    }
  ],
  "totalCount": 123,
  "skip": 123,
  "take": 123
}

Query Parameters

​
agentId
string

Optional unique agent identifier to filter aliases

​
skip
integer<int32>
default:0

Number of aliases to skip for pagination (default: 0, minimum: 0)

Required range: 0 <= x <= 2147483647
​
take
integer<int32>
default:20

Maximum number of aliases to return (default: 20, range: 0-1000)

Required range: 1 <= x <= 1000

Response

Returns the list of aliases

Paginated response wrapper

​
items
object[]
required
​
totalCount
integer<int32>
required
​
skip
integer<int32>
required
​
take
integer<int32>
required