List messaging URL domains

GET 
/messaging_url_domains

List messaging URL domains

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: Successful response with details about a messaging URL domain.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

id string

url_domain string

use_case string

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "record_type": "messaging_url_domain",
      "id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
      "url_domain": "http://example.com",
      "use_case": "test"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...