Skip to content

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/

Job Posts

Operations

Organizations

Operations

People

Operations

Websites

Operations

Users

Operations

Credit Balance Change Log

Request

The Credit Balance Change Log endpoint provides a list of all credit balance change logs related to the current subscription. It returns a list of credit balance change logs, including the change type, change sum, and change data. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management.

Security
Api-Key
Path
account_idintegerrequired
Query
date_created_endstring(date-time)
date_created_startstring(date-time)
pageinteger

A page number within the paginated result set.

curl -i -X GET \
  'https://api-v2.forager.ai/api/{account_id}/subscriptions/balance_change_logs/?date_created_end=2019-08-24T14%3A15%3A22Z&date_created_start=2019-08-24T14%3A15%3A22Z&page=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countinteger
Example: 15
nextinteger or null
Example: 2
previousinteger or null
Example: null
resultsArray of objects(CreditsBalanceChangeLog)
Response
application/json
{
  "count": 15,
  "next": 2,
  "previous": null,
  "results": [
    { … }
  ]
}

Credit Consumption Totals

Request

The Credit Consumption Totals endpoint calculates the total amount of credits spent during a specified timeframe. It returns the sum of all credit changes that have been made to the subscription balance during the given period. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management.

Security
Api-Key
Path
account_idintegerrequired
Query
date_created_endstring(date-time)
date_created_startstring(date-time)
curl -i -X GET \
  'https://api-v2.forager.ai/api/{account_id}/subscriptions/balance_change_logs/totals/?date_created_end=2019-08-24T14%3A15%3A22Z&date_created_start=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
total_credits_spentintegerrequired
Response
application/json
{
  "total_credits_spent": 0
}

List API keys

Request

API view for managing API keys.

Security
Api-Key
curl -i -X GET \
  https://api-v2.forager.ai/api/api_keys/ \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

]
Response
application/json
[
  {
    "prefix": "string",
    "created": "2019-08-24T14:15:22Z",
    "name": "string"
  }
]

Create a new API key

Request

Handle creation of a new API key.

Security
Api-Key
Body
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

curl -i -X POST \
  https://api-v2.forager.ai/api/api_keys/ \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

Bodyapplication/json
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

Response
application/json
{
  "prefix": "string",
  "created": "2019-08-24T14:15:22Z",
  "name": "string"
}

View API key details

Request

API view for managing API keys.

Security
Api-Key
Path
prefixstringrequired
curl -i -X GET \
  'https://api-v2.forager.ai/api/api_keys/{prefix}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

Response
application/json
{
  "prefix": "string",
  "created": "2019-08-24T14:15:22Z",
  "name": "string"
}

Delete API key

Request

API view for managing API keys.

Security
Api-Key
Path
prefixstringrequired
curl -i -X DELETE \
  'https://api-v2.forager.ai/api/api_keys/{prefix}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

No response body

View user information

Request

A view to retrieve current user details.

Security
Api-Key
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[].​plan_price_usdstring(decimal)(Plan price (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
accounts[].​subscription.​stripe_subscription_priceobjectread-onlyrequired

Stripe subscription price serializer.

accounts[].​subscription.​stripe_subscription_price.​idintegerread-onlyrequired
accounts[].​subscription.​stripe_subscription_price.​plan_price_usdstring(decimal)(Plan price (USD))^-?\d{0,8}(?:\.\d{0,2})?$
accounts[].​subscription.​stripe_subscription_price.​min_creditsinteger[ 0 .. 2147483647 ]
accounts[].​subscription.​stripe_subscription_price.​billing_cyclestring(BillingCycleEnum)
  • month - Month
  • year - Year
Enum"month""year"
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "accounts": [
    { … }
  ]
}

Autocomplete

Operations