Sign in

v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB
user

Create User

POST Create a Vital user given a client_user_id and returns the user_id.

post/v2/user

Request body

client_user_idstring required

A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

fallback_time_zonestring nullable
Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
fallback_birth_datestring date nullable

Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age.

ingestion_startstring date nullable

Starting bound for user data ingestion bounds.

ingestion_endstring date nullable

Ending bound for user data ingestion bounds.

Response

Successful Response

user_idstring uuid required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

team_idstring uuid required

Your team id.

client_user_idstring required

A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

created_onstring date-time required

When your item is created

ingestion_startstring date nullable

Starting bound for user data ingestion bounds.

ingestion_endstring date nullable

Ending bound for user data ingestion bounds.

Example response

{
  "client_user_id": "ZTEwZjNjMjctOTI2ZS00M2Vm",
  "connected_sources": [
    {
      "created_on": "2026-08-02T13:11:46+00:00",
      "source": {
        "logo": "logo_url",
        "name": "Oura",
        "slug": "oura"
      }
    }
  ],
  "created_on": "2026-08-02T13:11:46+00:00",
  "fallback_birth_date": {
    "source_slug": "manual",
    "updated_at": "2026-08-02T13:11:46+00:00",
    "value": "1989-09-12"
  },
  "fallback_time_zone": {
    "id": "Europe/London",
    "source_slug": "manual",
    "updated_at": "2026-08-02T13:11:46+00:00"
  },
  "team_id": "56bd81c9-6219-4000-a775-ae85526eba18",
  "user_id": "56bd81c9-6219-4000-a775-ae85526eba18"
}