Skip to main content
GET
/
api
/
v1
/
user
Get My Data
curl --request GET \
  --url 'https://api.example.com/api/v1/user?api_key='
{
  "message": "Data retrieved successfully",
  "meta": {},
  "data": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "is_superuser": false,
    "birthdate": "2023-11-07T05:31:56Z",
    "is_enterprise": false,
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phone": "<string>",
    "state": "<string>",
    "country": "<string>",
    "address": "<string>",
    "active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stripe_customer_id": "<string>",
    "stripe_subscription_id": "<string>",
    "stripe_subscription_status": "<string>",
    "stripe_has_payment_method": false,
    "is_trial": false,
    "used_trial": false,
    "is_paying": false,
    "stripe_last_payment_date": "2023-11-07T05:31:56Z",
    "billing_updated_at": "2023-11-07T05:31:56Z",
    "last_credits_refresh": "2023-11-07T05:31:56Z",
    "next_credits_refresh": "2023-11-07T05:31:56Z",
    "follower_count": 0,
    "following_count": 0
  }
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Response

200 - application/json

Successful Response

​
message
string | null
default:Data retrieved successfully
​
meta
Meta · object
​
data
IUserRead · object