List Email Subscriptions

GET /email_subscriptions

Retrieve a paginated collection of Email Subscriptions belonging to your Organization

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page integer

    Page number of the results to fetch.

    Default value is 1.

  • page_size integer

    Results per page (max 50)

    Default value is 20.

Responses

  • 200 application/json

    A collection of Email Subscriptions

    Hide headers attributes Show headers attributes
    • content-type string
    • x-arta-request-id string

      A unique identifier for the Arta API call

    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • created_at string
      • email_address string
      • email_notification_ids array[string]
      • id integer(int64)
      • name string
      • updated_at string
    • metadata object
      Hide metadata attributes Show metadata attributes object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
GET /email_subscriptions 
curl \
 --request GET 'https://api.arta.io/email_subscriptions' \
 --header "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "items": [
    {
      "id": 6,
      "name": "Arta Notifications",
      "created_at": "2020-10-14T15:25:48.298369",
      "updated_at": "2020-10-14T15:25:48.298369",
      "email_address": "notifications@shiparta.com",
      "email_notification_ids": [
        "booking",
        "complete",
        "scheduling"
      ]
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}