Skip to main content

me.get

Describe the account and credential this request is acting as

Request
GET/api/v1/me
Scope required
None. Any credential this API recognises may call it.
Effect
Reads only. Safe to retry and safe for an agent to call unprompted.
Acts on
Serves an account’s own data and, where shared, an organization’s.
MCP tool
me_get
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Answers who the calling credential acts as, in which environment, with which scopes, and which organizations that account belongs to. Call it first when you are handed a credential and do not yet know what it can reach: the scopes it lists are exactly the ones every other operation checks, and `environment` tells you whether the data you are about to change is real. It sits behind no scope of its own, so any credential this API recognises can discover what it holds; every other operation does check one, and refuses with 403 `insufficient_scope` whose `WWW-Authenticate` header names the scope it wanted. A credential restricted to one organization is told about that organization alone, never the others its owner belongs to. A sandbox credential answers with its synthetic tenant address rather than the owner's, because that is the account the rows it can see belong to. Users are not addressable resources here, so no user id is returned. Follow it with `boards.list` to find the board to work on.

Response

credential
object, required
displayPrefix
string, required
kind
one of: api_key, oauth_access_token, required
restrictedToOrganization
object or null, required
scopes
array of one of: applications:read, applications:write, boards:read, boards:write, companies:read, companies:write, contacts:read, contacts:write, interviews:read, interviews:write, insights:read, imports:write, resumes:read, resumes:write, profile:read, profile:write, organizations:read, organizations:write, organization_members:write, coach_notes:read, coach_notes:write, billing:read, billing:write, sandbox:manage, required
environment
one of: live, sandbox, required
organizations
array of object, required
name
string, required
role
one of: owner, admin, coach, applicant, required
slug
string, required
sandbox
object or null, required
user
object, required
displayName
string or null, required
email
string, required

Examples

A live key with read access to a personal job search

A live key with read access to a personal job search — request
curl -s https://www.jobapplicationtracking.com/api/v1/me \
  -H "Authorization: Bearer $JAT_KEY"
A live key with read access to a personal job search — response
{
  "user": {
    "email": "someone@example.com",
    "displayName": "Someone"
  },
  "environment": "live",
  "credential": {
    "kind": "api_key",
    "displayPrefix": "jat_live_9f2c",
    "scopes": [
      "boards:read",
      "profile:read"
    ],
    "restrictedToOrganization": null
  },
  "organizations": [],
  "sandbox": null
}

Related operations