[GET] - Subscription Details

  • Updated

This API allows you to view the details of a subscription. 

Endpoint

GET https://api.insideview.com/api/v1/subscription/{subscriptionId}

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). 

URI Parameters

Parameter Name Type Required Description
subscriptionId String Yes Provide Subscription ID

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

Company

  
{
  "companyIds": [
    "643462",
    "1042601",
    "643223",
    "642023",
    "26176",
    "643886",
    "848207",
    "741359",
    "643768",
    "642647"
  ],
  "startTime": "2015-11-09T23:15:07.000-08:00",
  "frequency": "1d",
  "fields": "all",
  "webhook": "http://cloudqa.dev.insideview.com:7777/Webhook/Webhook",
  "name": "sub1",
  "description": "desc",
  "nextFireTime": "2015-11-10T23:15:07.000-08:00",
  "page": 1,
  "totalResults": 10,
  "resultsPerPage": 5000,
  "subscriptionType": "company"
}

Company News

{
  "companyIds": [
    "643462",
    "1042601",
    "643223",
    "642023",
    "26176",
    "643886",
    "848207",
    "741359",
    "643768",
    "642647"
  ],
  "startTime": "2015-11-09T23:15:07.000-08:00",
  "frequency": "1d",
  "webhook": "http://cloudqa.dev.insideview.com:7777/Webhook/Webhook",
  "agents": "LEADERSHIP_CHANGES",
  "name": "sub1",
  "description": "desc",
  "nextFireTime": "2015-11-10T23:15:07.000-08:00",
  "page": 1,
  "totalResults": 10,
  "resultsPerPage": 5000,
  "subscriptionType": "companynews"
}

People

{
  "peopleIds": [
    "IDivDfKDNZlvpSQVZ2EixDo4Bm8IAk46feeac_FuSF6UwSLVRbiNE-0NKwWU1QLx"
  ],
  "startTime": "2016-07-28T00:15:07.000-07:00",
  "frequency": "1d",
  "fields": "all",
  "webhook": {
    "url": "http://xxx.xxx",
    "status": "VERIFICATION_PENDING"
  },
  "name": "sub1",
  "description": "desc",
  "nextFireTime": "2016-07-29T00:15:07.000-07:00",
  "page": 1,
  "totalResults": 1,
  "resultsPerPage": 5000,
  "subscriptionType": "people"
}

Company Family Tree

{
    "companyIds": ["726263", "643462","1042601" ],
    "startTime": "2018-08-12T00:15:07.000-07:00",
    "frequency": "1w",
    "fields": "all",
   "webhook": {
    "url": "http://xxx.xxx",
    "status": "DISABLED",
    "disableReasonMessage": "Webhook unreachable",
    "disableReasonErrorCode": "400-2100" 
  },
    "name": "stage_subscription_boa",
    "nextFireTime": "2018-09-18T03:30:07.000-07:00",
    "page": 1,
    "totalResults": 1,
    "resultsPerPage": 5000,
    "subscriptionType": "companyfamilytree"    
}

HTTP Error Codes

If Invalid SubscriptionId is provided

{
        "errorType": "VALIDATION_ERROR",
        "status": 400,
        "message": "Invalid subscription ID",
        "diagnosticCode": "8dniirf4h9qh50did5eg",
        "errorNumber": "400-1509"
}