Get subscriptions

get/v1/environments/{environmentId}/subscriptions

Page View

Subscription endpoints allow you to review and manage subscriptions in a specified environment.

You must be a member of the environment and be assigned to an engineer role to manage subscriptions. Learn about roles.

Get subscriptions

Retrieve a list of existing subscriptions in the specified environment.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/subscriptions' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

environmentId
required, string
Identifies the specific environment that you're operating in or on behalf of.

Query Parameters

_page
number
Indicates a specific page of results to return. This value typically comes from a previous response's page object.
_count
number
Defines the number of results to return per page. The maximum value per page is 50.
sourceId
string
Filters results to only include subscriptions with the specified source.
destinationId
string
Filters results to only include subscriptions with the specified destination.
sourceOrganizationId
number
Filters results to only include subscriptions where the source belongs to the specified organization.
destinationOrganizationId
number
Filters results to only include subscriptions where the destination belongs to the specified organization.
connectingOrganizationId
number
Filters results to only include subscriptions where either the source or destination belongs to the specified organization.
dataModel
string
Filters results to only include subscriptions using the specified data model.
searchTerm
string
Uses the specified term to find a match within a source or destination ID or name.
orderBy
string
Lists the results according to the specified field.
isAscending
boolean
When true, sorts results in ascending order. When false, sorts in descending order.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "subscriptions": [
7
      {
8
        "id": 0,
9
        "name": "string",
10
        "dataModel": "string",
11
        "isLive": true,
12
        "goLiveDate": "2019-08-24T14:15:22Z",
13
        "deletedAt": "2019-08-24T14:15:22Z",
14
        "createdAt": "2019-08-24T14:15:22Z",
15
        "source": {
16
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
17
          "name": "string",
18
          "environmentFlag": "Production",
19
          "environment": "string",
20
          "organization": {
21
            "id": 122,
22
            "name": "string"
23
          }
24
        },
25
        "destination": {
26
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
27
          "name": "string",
28
          "environmentFlag": "Production",
29
          "environment": "string",
30
          "organization": {
31
            "id": 122,
32
            "name": "string"
33
          }
34
        }
35
      }
36
    ]
37
  }
38
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
payload
object
Contains the payload with a list of subscriptions.
- subscriptions
  Array of object
  Contains an array of subscriptions.
  id
  number
  Displays the unique identifier of the subscription.
  name
  nullable, string
  Displays the human-readable name of the subscription.
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  isLive
  nullable, boolean
  Indicates whether this subscription has been activated and is currently in production.
  goLiveDate
  nullable, string
  If live, specifies when the subscription was activated.
  Format: date-time
  deletedAt
  nullable, string
  If applicable, specifies when the subscription was deleted.
  Format: date-time
  createdAt
  string
  Indicates when the subscription was created.
  Format: date-time
  source
  object
  Shared schema representing either the source or destination side of a subscription. Both source and destination are always present on a subscription response.
  id
  string
  Contains the unique identifier of the source or destination.
  Format: uuid
  name
  string
  Displays the human-readable name of the source or destination.
  environmentFlag
  string
  Indicates the environment type of the source or destination.
  environment
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  organization
  object
  Contains metadata about the Redox organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  destination
  object
  Shared schema representing either the source or destination side of a subscription. Both source and destination are always present on a subscription response.
  id
  string
  Contains the unique identifier of the source or destination.
  Format: uuid
  name
  string
  Displays the human-readable name of the source or destination.
  environmentFlag
  string
  Indicates the environment type of the source or destination.
  environment
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  organization
  object
  Contains metadata about the Redox organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.