Skip to main content

Akoya
Documentation

Get Valid Providers For Products

GET

https://sandbox-api.akoya.com/manage/{version}/recipients/{recipientId}/providers

Get a paginated list of all providers connected to Akoya that support any of the products passed in as a query parameter (products).

The payload now includes the following fields:

  • provider_id - providerId

  • display_name - The provider's display name

  • logo - The provider's full logo

  • icon - The provider's icon (often a submark logo)

  • provider_url - The provider's website

Logo and icon details logo and icon are URLs to image files hosted on Akoya’s CDN (cdn.akoya.com). They are not image data. All images are checked when a provider is set up on the network: • Logo: PNG or JPEG, between 200 and 1080 pixels in width and height, up to 2 MB. Logos are not always square. • Icon: square PNG or JPEG, between 40 and 200 pixels, up to 2 MB. Sizes vary by provider, and backgrounds may not be transparent, so scale images to fit your interface rather than assuming a fixed size.

logo and icon are omitted from the response when a provider hasn’t shared a logo.

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. recipientId*

    string

    Your recipient id. You may find your recipientId in the Data Recipient Hub under Team Management/Company Id.

Query Parameters

  1. products*

    string

    Akoya product (e.g. balances).

    Example: balances


Responses

  1. 200

    OK

    Response Body

      page

      object

          total_elements

          integer

      links

      object

          next

          object

              href

              string

      providers

      array of objects

        object

          provider_id

          string

          display_name

          string

          logo

          string

          icon

          string

          provider_url

          string

    Headers

    1. Content-Typestring

    2. X-Akoya-Interaction-Idstring

CTRL + K

Try it

Authorization