GET /members

This resource returns the list of consortium members related to a Customer_ID.

Request

Base URL
https://api.clarivate.com/api/counter/r5
Auth
API key in header X-ApiKey
TypeScript
https://skmtc.dev/clarivate/apis/web-of-science-sushi-counter5-api/docs/members/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

api_keystring required

Developer key parameter, which authenticates you to use the service.

customer_idstring required

Identifies the customer to provide report data for.

requestor_idstring required

Identifies the requester (STeAM User Id) that is asking for report data

Response

List of member accounts (sites) associated with the Customer_ID passed in as a parameter.

Customer_IDstring required

Identifer for the consortium's member account. This identifier would be used as the Customer_ID for subsequent report requests for the member.

Requestor_IDstring

The RequestorID to use to retrieve COUNTER stats the consortium's member account -- only include if different from the main consortium's RequestorID. This identifier would be used as the Requestor for subsequent report requests for the member.

Namestring required

Customer name assigned to the consortium member.

Notesstring

Additional notes regarding the customer.

Example response

[
  {
    "Customer_ID": "1557c9eebf17b8fc56da59756791b636",
    "Name": "Mt. Laurel University Medical School",
    "Notes": "Usage pulled using content licensed by the consortium."
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.