Skip to content
Tidepool API/Clinics API/
/
Get Migration

Get Migration

Request

Get a migration by user id

Security
sessionToken
Path
clinicIdstring, = 24 characters(Clinic ID)^[a-f0-9]{24}$read-onlyrequired

Clinic ID

Example:2fe2488217ee43e1b2e83c2f
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/2fe2488217ee43e1b2e83c2f/migrations/{userId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
userIdstring, non-emptyrequired

The user id of the legacy clinician account that needs to be migrated.

statusstring(Migration Status)

The current status of the migration

Enum:"PENDING""RUNNING""COMPLETED"
createdTimestring, (date-time)read-onlyrequired
updatedTimestring, (date-time)read-onlyrequired
attestationTimestring, (date-time)read-only
Response
{
  "userId": "string",
  "status": "PENDING",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationTime": "2019-08-24T14:15:22Z"
}