PostMyIsh

API reference

Get current user

Verify an API key and read the account, plan, limits, and usage.

GET/api/v1/me

Requires a Bearer API key — see authentication.

Returns the account behind the API key, along with the plan's limits and the current month's API usage. This is the simplest way to confirm a key works.

Request

Send the request to GET /api/v1/me. Set your key in the environment as POSTMYISH_KEY to run these as-is.

curl https://postmyish.com/api/v1/me \
  -H "Authorization: Bearer $POSTMYISH_KEY"

Response

{
  "id": "usr_9f2c8b1e",
  "email": "you@studio.com",
  "name": "Ada Lovelace",
  "studio": "Analytical Engines",
  "plan": "creator",
  "limits": {
    "profiles": 5,
    "posts_per_month": null,
    "api_calls_per_month": 10000
  },
  "usage": {
    "api_calls_this_month": 42
  }
}

Response fields

idstring
Your account id.
emailstring
Account email address.
namestring
Account display name.
studiostring | null
Studio / workspace name, if set.
planstring
Current plan: free, creator, studio, or scale.
limitsobject
The plan's ceilings. A null value means unlimited.
profilesinteger | null
Max connected profiles.
posts_per_monthinteger | null
Posts allowed per calendar month.
api_calls_per_monthinteger | null
Monthly REST API call allowance.
usageobject
Live usage counters.
api_calls_this_monthinteger
API calls counted against this month's allowance.

Try it

Run this endpoint live with your own key. The key is kept in your browser (local storage) and sent straight to the API — nothing passes through the docs.

Related

Authentication

Rate limits & plans