View all Subscriptions

View all Subscriptions

GET https://api.synapsefi.com/v3.1/subscriptions

This endpoint allows you to get all subscriptions linked to your client keys.

Query Parameters

Name	Type	Description
page	integer	Page number
per_page	integer	Number of subscriptions per page

Headers

Name	Type	Description
X-SP-GATEWAY	string	Your Client ID & Secret, separated by a pipe

200 Subscriptions successfully returned.

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "page": 1,
  "page_count": 1,
  "subscriptions": [
    {
      "_id": "589b6adec83e17002122196c",
      "_links": {
        "self": {
          "href": "https://uat-api.synapsefi.com/v3.1/subscriptions/589b6adec83e17002122196c"
        }
      },
      "_v": 2,
      "client_id": "589acd9ecb3cd400fa75ac06",
      "is_active": true,
      "scope": [
        "USERS|POST",
        "USER|PATCH",
        "NODES|POST",
        "NODE|PATCH",
        "TRANS|POST",
        "TRAN|PATCH",
        "SUBNETS|POST",
        "SUBNET|PATCH"
      ],
      "url": "https://requestb.in/zp216zzp"
    },
    {
      ...
    }
  ],
  "subscriptions_count": 2,
  "success": true
}

400 Could not find subscriptions matching this query.

{}

Example Request

HTTP

GET /v3.1/subscriptions HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW

Python

client.get_all_subs()

JavaScript

client.getAllSubscriptions();

Ruby

client.get_all_subscriptions()

PHP

$client->get_all_subscriptions();

Go

data, err := client.GetSubscriptions()