users

Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api-v2.forager.ai/

datastorage

Operations

organizations

Operations

persons

Operations

subscriptions

Operations

api_keys

Operations

users

Operations

View user information

Request

A view to retrieve current user details.

curl -i -X GET \
  https://api-v2.forager.ai/api/users/current/ \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
usernamestring<= 150 characters^[\w.@+-]+$required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

emailstring(email)(Email address)<= 254 charactersrequired
first_namestring<= 150 characters
last_namestring<= 150 characters
accountsArray of objects(Account)read-onlyrequired
accounts[].​idintegerread-onlyrequired
accounts[].​namestring<= 255 charactersrequired
accounts[].​subscriptionobjectread-onlyrequired

Subscription serializer.

accounts[].​subscription.​idintegerread-onlyrequired
accounts[].​subscription.​is_activeboolean(Is active?)
accounts[].​subscription.​credits_balanceintegerread-onlyrequired
accounts[].​subscription.​subscription_tierobjectread-onlyrequired

Subscription tier serializer.

accounts[].​subscription.​subscription_tier.​idintegerread-onlyrequired
accounts[].​subscription.​subscription_tier.​namestring<= 35 charactersrequired
accounts[].​subscription.​subscription_tier.​person_details_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_work_email_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_personal_email_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_phone_number_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_reverse_email_searchinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_reverse_phone_number_searchinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_role_details_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​person_role_search_api_callinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​job_search_api_callinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​organization_search_api_callinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​organization_technologies_lookupinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​featuresArray of objects(SubscriptionTierFeature)read-onlyrequired
accounts[].​subscription.​subscription_tier.​features[].​descriptionstring<= 255 charactersrequired
accounts[].​subscription.​subscription_tier.​stripe_subscription_pricesArray of objects(StripeSubscriptionPrice)read-onlyrequired
accounts[].​subscription.​subscription_tier.​stripe_subscription_prices[].​idintegerread-onlyrequired
accounts[].​subscription.​subscription_tier.​stripe_subscription_prices[].​price_per_month_usdstring(decimal)(Price per month (USD))^-?\d{0,8}(?:\.\d{0,2})?$
accounts[].​subscription.​subscription_tier.​stripe_subscription_prices[].​min_creditsinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​subscription_tier.​stripe_subscription_prices[].​billing_cyclestring(BillingCycleEnum)
  • month - Month
  • year - Year
Enum"month""year"
accounts[].​subscription.​stripe_subscription_idstring or null<= 65 characters
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "accounts": [
    { … }
  ]
}

objects-lookups

Operations