Skip to main content
GET
/
v1
/
user
Get Extruct User
curl --request GET \
  --url https://api.extruct.ai/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "<string>",
  "email": "<string>",
  "available_credits": 123,
  "organization_id": "<string>",
  "organization_name": "<string>",
  "organization_slug": "<string>",
  "organization_is_active": true
}

Overview

This endpoint returns details about the authenticated user, including available credits. It is a good first authenticated request when validating API access.

Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"

curl --get "https://api.extruct.ai/v1/user" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}"

Key parameters

  • Authorization header (required): Bearer ${EXTRUCT_API_TOKEN}.

Success signal

A successful response includes email and available_credits.

Common errors

401 Unauthorized

Check that your token is valid and the header includes Bearer prefix.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

user_id
string
required
email
string
required
available_credits
integer
required
organization_id
string | null
organization_name
string | null
organization_slug
string | null
organization_is_active
boolean | null