Get subscription executions

1min
GET
https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions/{subscriptionId}/executions
Get the subscriptions executions.
Execution Storage and Expiry:
Executions are stored within the system and have a Time-to-Live (TTL) expiry set to 7 days.
This means that execution records older than 7 days are automatically removed from the storage.
When using the date query parameter, the endpoint retrieves executions within the specified date, keeping in line with the 7-day storage limit.
Max 20 executions logs can be fetching per request.
Path Parameters
subscriptionId
string
*
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
date
string
nextPage
string
status
string
Responses
200
OK - The request succeeded.
ExecutionResponsePaginated
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/{subscriptionId}/executions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/subscriptions/{subscriptionId}/executions' \
--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
    },
    "executions": [
      {
        "subscriptionId": "a0405428-64b6-4a47-b1ec-4fa75ab5ec2b",
        "event": "AvailableUsersEvent",
        "error": "",
        "status": "",
        "response": {
          "httpStatus": 202,
          "data": "{'status': 'accepted'}"
        },
        "retryCount": 0,
        "executedAt": 1702367233
      }
    ]
  }
}
// OK - The request succeeded. 
{
  "data": {
    "meta": {
      "nextPage": "",
      "hasNextPage": false
    },
    "executions": [
      {
        "subscriptionId": "a0405428-64b6-4a47-b1ec-4fa75ab5ec2b",
        "event": "AvailableUsersEvent",
        "error": "",
        "status": "",
        "response": {
          "httpStatus": 202,
          "data": "{'status': 'accepted'}"
        },
        "retryCount": 0,
        "executedAt": 1702367233
      }
    ]
  }
}
﻿
﻿
Updated 07 Feb 2024
Did this page help you?
Add/remove events to the subscription.
Create type with attribute aliases