JobsPipe
API Reference

Account

Find out which account a credential belongs to, its plan and this month's credit usage with GET /v1/account.

GET https://api.jobspipe.dev/v1/account

Returns the account behind the credential you sent, the plan it is on, and how much of this calendar month's allowance is used and left. It costs no credits and does not count against the per-second rate limit, so it is safe to call before a large search.

It accepts the same credentials as every other /v1 endpoint: an API key (Authorization: Bearer jp_live_... or x-api-key) or an OAuth access token. The MCP server's get_account_info tool returns this same response.

curl https://api.jobspipe.dev/v1/account \
  -H "Authorization: Bearer $JOBSPIPE_API_KEY"

Response

200 OK
{
  "user_id": "Au3mfHLFBxkbDCyYaKJVXX73oEI3vulY",
  "email": "ada@example.com",
  "name": "Ada Lovelace",
  "auth_type": "api_key",
  "plan": "builder",
  "month": "2026-09",
  "monthly_credits": 25000,
  "credits_used": 225,
  "credits_remaining": 24775,
  "extra_credits": 0,
  "max_results_per_request": 100,
  "requests_per_second": 10
}

Fields

FieldTypeDescription
user_idstringThe account's user ID.
emailstring | nullAccount email.
namestring | nullDisplay name.
auth_typestringHow this request was authenticated: api_key, oauth or session.
planstringThe plan name, or credits:N for a plan of N thousand credits a month.
monthstringThe calendar month the usage figures cover, YYYY-MM in UTC.
monthly_creditsnumberCredits included in the plan each month.
credits_usednumberCredits counted against the allowance this month - one per distinct job delivered; a job already paid for this month is not counted again.
credits_remainingnumbermonthly_credits minus credits_used, never below zero.
extra_creditsnumberOne-time credits bought on top of the plan. They are drawn only after the monthly allowance and are not part of credits_remaining.
max_results_per_requestnumberThe largest limit a search accepts on this plan.
requests_per_secondnumberThe plan's per-second rate limit.

Errors

StatusMeaning
401No credential was sent, or it was not valid.

On this page