View Subscriptions

Get details on all subscriptions

page:
integer

Page number

per_page:
integer20

Number of Subscriptions per page

EXAMPLE REQUEST

GET /v3.1/subscriptions HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267
client.get_all_subs()
client.getAllSubscriptions();
client.get_all_subscriptions()
$page = 1;
$per_page = 1;

$client->get_all_subscriptions($page, $per_page);
data, err := client.GetSubscriptions()

EXAMPLE RESPONSE

{
    "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
}

PAGINATION

Responses are paginated, so to move through pages, add page as a GET parameter. Here is an example

GET /v3.1/subscriptions?page=2 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267

View Subscriptions


Get details on all subscriptions

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.