Get subscriptions

1min
GET
https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions
Get the subscriptions for the app.
Note: This api will return minimal information. For viewing the events and webhook details, use get subscription by Id app.
Header Parameters
X-COREOS-APP-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-AUTH
string
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
*
Query Parameters
nextPage
string
limit
integer
Responses
200
OK - The request succeeded.
SubscriptionsResponsePaginated
data
object
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions?limit=20' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions?limit=20' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
503
// OK - The request succeeded. 
{
  "data": {
    "meta": {
      "nextPage": "",
      "hasNextPage": false
    },
    "subscriptions": [
      {
        "id": "",
        "description": "This is a sample subscription",
        "topic": "sample-topic-name",
        "eventsAppName": "",
        "isActive": false,
        "customAttr": false
      }
    ]
  }
}
// OK - The request succeeded. 
{
  "data": {
    "meta": {
      "nextPage": "",
      "hasNextPage": false
    },
    "subscriptions": [
      {
        "id": "",
        "description": "This is a sample subscription",
        "topic": "sample-topic-name",
        "eventsAppName": "",
        "isActive": false,
        "customAttr": false
      }
    ]
  }
}
﻿
﻿
Updated 07 Feb 2024
Did this page help you?
Create subscription
Update subscription