Differences from RPI Get Sites Endpoint

⚠️ This endpoint has some important differences from the RPI GET sites endpoint.
They cannot be used interchangeably. Doing so will result in errors.

Authorization

Note: unlike the RPI GET sites endpoint, this endpoint does not use an auth token. The Authorization header should not be included in this request. Doing so will cause the request to fail.

IDs

Although the Study Website GET sites endpoint returns similar looking data to the RPI Get Sites endpoint, they return different IDs. The IDs returned from this endpoint cannot be used with any of the RPI endpoints.

How to use the Study Websites GET Sites endpoint

GET Sites - Used for a Site List Component

GET <base URL>/microsites-api/v1/:microsite_id/sites/:trial_id

Required fields:

• microsite ID
• trial ID

This endpoint requires an HTTP GET request and checks if the requesting origin/microsite/trial combination has the proper permission to read data. When authorized, it returns all sites configured for that trial. Note that since origin is checked you must specify it when using something like CURL or Postman.

A note on nomenclature: Study Websites/Study Modules were previously called "Microsites"

How to get the necessary information?

OneStudyTeam will share these IDs with you during the integration.

Base URL Values

Example

CURL Request

curl -H "Origin: https://example.com" \
https://staging.api.studyteamapp.com/microsites-api/v1/1682c0a1-6c64-4453-aa10-f6bdf73d6f69/sites/d27b1d88-90d2-43c5-b295-15f2207cb81f

Response Data

[
  {
    "siteId": "78987437-6a33-40e3-b484-335bbc6dd060",
    "displayName": "Study Websites Test Site",
    "city": "Boston",
    "longitude": 122.222,
    "state": "MA",
    "sponsorSiteId": "100",
    "street": "101 Main St.",
    "address1": "101 Main St.",
    "address2": null,
    "postalCode": "02140",
    "siteName": "Study Websites Test Site",
    "latitude": 11.22,
    "phoneNumber": "262-303-2299",
    "country": "US"
  }
]