Skip to main content
GET
/
api
/
gateways
GET /api/gateways
curl --request GET \
  --url https://api.sippet.ai/api/gateways \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "inbound_acl": [
          "<string>"
        ],
        "name": "<string>",
        "realm": "<string>",
        "username": "<string>",
        "from_domain": "<string>",
        "from_user": "<string>",
        "password": "<string>",
        "provider": "vonage",
        "proxy": "<string>",
        "register": true
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "<string>",
            "type": "<string>",
            "meta": {}
          }
        }
      }
    }
  ],
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Query Parameters

​
filter
object

Filters the query to results with attributes matching the given filter object Filters the query to results matching the given filter object

Example:
{}
​
sort
string

Sort order to apply to the results

Pattern: ^(id|-id|\+\+id|--id|name|-name|\+\+name|--name|provider|-provider|\+\+provider|--provider|username|-username|\+\+username|--username|realm|-realm|\+\+realm|--realm|proxy|-proxy|\+\+proxy|--proxy|register|-register|\+\+register|--register|from_domain|-from_domain|\+\+from_domain|--from_domain|from_user|-from_user|\+\+from_user|--from_user)(,(id|-id|\+\+id|--id|name|-name|\+\+name|--name|provider|-provider|\+\+provider|--provider|username|-username|\+\+username|--username|realm|-realm|\+\+realm|--realm|proxy|-proxy|\+\+proxy|--proxy|register|-register|\+\+register|--register|from_domain|-from_domain|\+\+from_domain|--from_domain|from_user|-from_user|\+\+from_user|--from_user))*$
​
page
object

Paginates the response with the limit and offset or keyset pagination.

Example:
{ "limit": 25 }
​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{
  "Gateway": "id,name,provider,username,realm,proxy,register,from_domain,from_user,inbound_acl"
}

Response

Success

​
data
object[]

An array of resource objects representing a Gateway

​
included
any[]
​
meta
object