Account

Get the account behind this credential

Returns who the API key or OAuth token belongs to, the plan it is on and this month's credit usage. Costs no credits and does not count against the search rate limit.

get/v1/account

Request

  • Base URL: https://api.jobspipe.dev
  • URL: https://api.jobspipe.dev/v1/account
  • Auth: none declared

Response

The connected account.

user_idstring required
emailstring nullable required
namestring nullable required
auth_typestring required

How this request was authenticated: api_key, oauth or session.

planstring required

A plan name, or credits:N for N thousand credits a month.

monthstring required

The calendar month the usage figures cover, YYYY-MM in UTC.

monthly_creditsinteger required

Credits included each month. 0 on Free, which is a one-time grant instead.

one_time_creditsinteger nullable required

Free only: the one-time credits the account started with (1,000; more if support added some). They do not renew. Null on paid plans.

credits_usedinteger required

Paid: credits used this month. Free: credits used of the one-time grant.

credits_remaininginteger required

Paid: left of this month's allowance. Free: left of the one-time grant.

extra_creditsinteger required

One-time credits bought on top of the plan, drawn after the monthly allowance.

max_results_per_requestinteger required
requests_per_secondnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.