Sign in
latestOpenAPI 3.0.3Netlas API & Data License Agreement2026-08-104487309.0 KB

2b1f84425791

Users

Update User Profile

Modify the profile details of the currently authenticated user.

patch/api/users/current/

Request body

first_namestring

The user's first name.

last_namestring

The user's last name.

Response

Profile Data

emailstring email

The user's email address.

first_namestring

The user's first name.

last_namestring

The user's last name.

account_category'company' | 'individual' | 'non-profit'

Data specified during registration.

occupationstring

Data specified during registration.

occupation_detailsstring

Data specified during registration.

is_welcome_tour_passedboolean

Indicates if the user has completed the welcome tour.

planobject

Information about the user's subscription plan.

plan_active_untilstring date nullable

The date until the current plan is active.

next_planobject

Information about the subscription plan that will be activated after the current one expires.

is_next_plan_paidboolean

Indicates if the next subscription period is paid (used for one-time purchases only).

next_plan_paid_periodstring

The paid period for the next plan.

referral_codestring

The user's referral code.

bonusesinteger

The number of bonus points available to the user.

notificationsinteger[]

A list of subscriptions and notification channels.

teamsobject[]

A list of teams the user is part of.

is_recurringboolean

Indicates if the subscription is recurring.

is_authenticated_via_socialboolean

Indicates whether the user is authenticated via a third-party service.

referral_link_usage_amountinteger

The number of times the referral link has been used.

professionstring nullable

Deprecated field

usage_purposestring nullable

Deprecated field

Example response

{
  "api_key": {
    "customer_api_key": "eXamPleAPIKey"
  },
  "teams": [
    {
      "name": "netlas-team"
    }
  ]
}