Skip to main content

Overview

Create user​

post

/v2/user/

Request fields and example

No parameters

Create a Vital User
1
2
3
4
5
6
7
8
9
10
curl --request POST \
     --url https://api.tryvital.io/v2/user/ \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '
{
     "client_user_id": "your_unique_id"
}
'
Response fields and example

No parameters

Response
1

Get user​

get

/v2/user/{user_id}

Request fields and example

No parameters

Get a Vital User
1
2
3
4
curl --request GET \
     --url https://api.tryvital.io/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'
Response fields and example

No parameters

Response
1

Delete user​

delete

/v2/user/{user_id}

Request fields and example

No parameters

Delete a Vital User
1
2
3
4
curl --request DELETE \
     --url https://api.tryvital.io/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'
Response fields and example

No parameters

Response
1

Get all users for team​

get

/v2/user/

Request fields and example

No parameters

Delete a Vital User
1
2
3
4
curl --request GET \
     --url https://api.tryvital.io/v2/user/ \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'
Response fields and example

No parameters

Response
1

Get users connected providers​

get

/v2/user/providers/{user_id}

Request fields and example

No parameters

Delete a Vital User
1
2
3
4
curl --request GET \
     --url https://api.tryvital.io/v2/user/providers/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'
Response fields and example

No parameters

Response
1

Refresh users data​

post

/v2/user/refresh/{user_id}

Request fields and example

No parameters

Refresh data for Vital User
1
2
3
4
curl --request POST \
     --url https://api.tryvital.io/v2/user/refresh/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'
Response fields and example

No parameters

Response
1

Deregister provider for user​

delete

/v2/user/{user_id}/{provider}

Request fields and example

No parameters

Refresh data for Vital User
1
2
3
4
curl --request DELETE \
     --url https://api.tryvital.io/v2/user/{user_id}/provider \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'
Response fields and example

No parameters

Response
1