Skip to main content

[GET] - List All Subscriptions

  • Updated

Use this API allows to view all notification subscriptions. 

Endpoint

GET https://api.insideview.com/api/v1/subscriptions

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes

Valid access token.
See Authentication and Authorization Overview for more details.
Accept String No Selects the response's content type.  
Valid values are application/json and application/xml (default). 

Responses

HTTP 200

Type: application/json

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "object",
  "properties": {
    "subscriptions": {
      "id": "subscriptions",
      "type": "array",
      "items": {
        "id": "0",
        "type": "object",
        "properties": {
          "subscriptionType": {
            "id": "subscriptionType",
            "type": "string"
          },
           "subscriptionId": {
            "id": "subscriptionId",
            "type": "string"
          },
           "name": {
            "id": "name",
            "type": "string"
          },
          "description": {
            "id": "description",
            "type": "string"
          }
        }
      }
    }
  }
}

Example

{
  "subscriptions": [
    {
      "name": "Sub1",
      "description": "DESC",
      "subscriptionType": "company",
      "subscriptionId": "v7rc53mab1rlnh78fgsb"
    },
    {
      "subscriptionType": "companynews",
      "subscriptionId": "j8ovn57m01upo3nf5df7"
    },
  ]
}

Type: application/xml

Schema

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="subscriptions">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="subscription" maxOccurs="unbounded" minOccurs="0">
          <xs:complexType>
            <xs:sequence>
              <xs:element type="xs:string" name="description" minOccurs="0"/>
              <xs:element type="xs:string" name="name" minOccurs="0"/>
              <xs:element type="xs:string" name="subscriptionId"/>
              <xs:element type="xs:string" name="subscriptionType"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptions>
    <subscription>
        <subscriptionId>4aqhjd2ss4bv0l3fda0j</subscriptionId>
        <subscriptionType>company</subscriptionType>
    </subscription>
    <subscription>
        <description>DESC</description>
        <name>Sub1</name>
        <subscriptionId>v7rc53mab1rlnh78fgsb</subscriptionId>
        <subscriptionType>company</subscriptionType>
    </subscription>
    <subscription>
        <subscriptionId>7q3d49jlgbv83avcsmnk</subscriptionId>
        <subscriptionType>companynews</subscriptionType>
    </subscription>
    <subscription>
        <description>desc</description>
        <name>sub1</name>
        <subscriptionId>3culgtv0tm3q61d17vij</subscriptionId>
        <subscriptionType>companynews</subscriptionType>
    </subscription>
</subscriptions>