Documentation menu

← Account

API reference

Retrieve the current credential

GET/v1/me

Returns the organization, plan, scopes and credit balance of the API key or token making the request.

Parameters

No parameters.

Responses

200
account object
The credential.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Credits

Free.

Example request

curl -X GET 'https://api.placestack.com/v1/me' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "credential",
  "organization": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "organization_name": "Acme Realty",
  "plan": "build",
  "kind": "machine",
  "subject": "0192f3a4-7d8e-7f90-b123-456789abcdef",
  "method": "api_key",
  "name": "Production",
  "scope": [
    "record:read"
  ],
  "credit_balance": 1,
  "user": "0192f3a4-6c7d-7e8f-a012-3456789abcde"
}

Next steps

GET /usage

Retrieve usage

Continue