GET /v1/me · API reference

Free, whatever the credential. A caller who cannot find out why they are being refused opens a ticket.

Parameters

No parameters.

Responses

200: account object; Successful Response
401: ProblemDetail; credential_missing, credential_invalid or credential_expired: send a live API key as Authorization: Bearer <key>.
402: ProblemDetail; quota_exhausted: the balance can't cover the call. Nothing was charged and nothing was returned.
403: ProblemDetail; scope_missing, person_required or entitlement_missing: this credential or plan can't do this. detail says which.
404: ProblemDetail; no_such_resource: nothing has that id.
409: ProblemDetail; version_conflict: the record changed since you read it. Read it again and resend.
422: ProblemDetail; parameter_invalid, id_malformed or a cursor code: a parameter's value isn't one this operation takes.
429: ProblemDetail; rate_limited: wait for Retry-After, then send it again. Not charged.

Example request

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

Example response

{
  "object": "credential",
  "organization": "<Organization>",
  "organization_name": "<Organization Name>",
  "plan": "<Plan>",
  "kind": "<Kind>",
  "subject": "<Subject>",
  "method": "<Method>",
  "name": "<Name>",
  "scope": [
    "string"
  ],
  "credit_balance": 1,
  "user": "string"
}