Team Custom Credentials
Team Data Pull Preferences
Team Scope Requirements
Get Team
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team/{team_id} \
--header 'X-Vital-Org-Key: <api-key>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"region": "us",
"environments": [
"production"
],
"sandbox": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true,
"brand_information": {
"company_name": "<string>",
"company_website": "<string>",
"support_email": "jsmith@example.com",
"support_contact": "<string>",
"company_address": "<string>",
"brand_color": "<string>"
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false
},
"production": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true,
"brand_information": {
"company_name": "<string>",
"company_website": "<string>",
"support_email": "jsmith@example.com",
"support_contact": "<string>",
"company_address": "<string>",
"brand_color": "<string>"
},
"logo_url": "<string>",
"reject_duplicate_connection": true,
"sdk_per_device_activity_timeseries": true
}
}
Org Management API is available for the Scale plan.
The base URL of this endpoint is https://api.tryvital.io/management/
.
The endpoint accepts only Org Key (X-Vital-Org-Key
). Team API Key is not applicable.
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team/{team_id} \
--header 'X-Vital-Org-Key: <api-key>'
Authorizations
Query Parameters
production
, sandbox
Response
us
, eu
Information of your brand.
In the Vital Link widget, you are by default represented as the Team name. However, if you configure Brand Information for the environment, the Company Name takes precedence.
In Vital Lab Testing, all communications use only Brand Information. Team name is ignored.
1 - 2083
Information of your brand.
In the Vital Link widget, you are by default represented as the Team name. However, if you configure Brand Information for the environment, the Company Name takes precedence.
In Vital Lab Testing, all communications use only Brand Information. Team name is ignored.
1 - 2083
production
, sandbox
curl --request GET \
--url https://api.tryvital.io/management/v1/org/{org_id}/team/{team_id} \
--header 'X-Vital-Org-Key: <api-key>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"region": "us",
"environments": [
"production"
],
"sandbox": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true,
"brand_information": {
"company_name": "<string>",
"company_website": "<string>",
"support_email": "jsmith@example.com",
"support_contact": "<string>",
"company_address": "<string>",
"brand_color": "<string>"
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false
},
"production": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true,
"brand_information": {
"company_name": "<string>",
"company_website": "<string>",
"support_email": "jsmith@example.com",
"support_contact": "<string>",
"company_address": "<string>",
"brand_color": "<string>"
},
"logo_url": "<string>",
"reject_duplicate_connection": true,
"sdk_per_device_activity_timeseries": true
}
}