Skip to main content

Akoya
Documentation

Get Subscriptions For App - Filter By Status

GET

sandbox-api.akoya.com/manage/{version}/subscriptions/{appId}/status

Get a paginated list of all subscriptions filtered by the status query parameter for this application.

Valid values for the status enum are:

  • ACTIVE

  • PENDING

  • PROCESSING

  • TERMINATED

  • DENIED

You can use the next and the prev links to page through the response. You can also pass a offset and a limit parameter to get a specific page. The default page size is 50 and the maximum allowed page size is 500.

Path Parameters

  1. version*

    string

    Management API major version (e.g. v2)

  2. appId*

    string

    The id of your application

Query Parameters

  1. status*

    string

    Your subscription status

    Example: ACTIVE

  2. offset

    integer

    Number of skipped items (default = 0)

    Example: 1

  3. limit

    integer

    Number of items per page (default = 50, must be <=500)

    Example: 2

Responses

  1. 200

    OK

    Response Body

      page

      object

          total_elements

          integer

      links

      object

          next

          object

              href

              string

          prev

          object

              href

              string

      subscription_status

      array of objects

        object

          provider_id

          string

          display_name

          string

          status

          string

          products

          array of strings

            string

    Headers

    1. Content-Typestring

    2. x-akoya-interaction-idstring

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"accept": "application/json"
	}
}};
fetch('sandbox-api.akoya.com/manage//subscriptions//status?status=ACTIVE&offset=&limit=', options)
  .then(response => response.json())
  .catch(err => console.error(err));
Back