Get Vendors

get

https://sandbox.ebsco.io/rm/rmaccounts/{custid}/vendors

This operation allows you to search EPKB by vendor. It returns a list of vendors that includes customer context and the total number of results. When searching for vendors without a search parameter, sort options will be by vendor name. When the search parameter is not null, the default sort is by relevance.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Path Params

custid

string

required

EBSCO Customer ID

Query Params

string

Search Term - When searching for vendors without a search parameter, sort options will be by vendorname. When the search parameter is not null, the default sort is by relevance. Special characters in the search term need to be URL encoded. Ex: A&G encodes to A%26G. The Swagger Explorer performs the search parameter encoding for the Try it out!.

orderby

string

enum

required

Valid values are relevance and vendorname. Default is relevance.

Allowed:

count

integer

enum

required

The maximum number of results to return in the response.

Allowed:

offset

integer

required

Page Offset. Starts at 1.

show

string

Valid values are All, Selected and Unselected.

Headers

x-api-key

string

required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of vendors matching the vendor name and the total number vendors found.

defaultUnexpected Error