Accounts

Who Am I

Returns the API key's identity — its display name, key prefix, creation timestamp, assigned roles, and the full list of granted permissions. Use this to introspect what the current key can do without trial-and-erroring against protected endpoints.

https://public-api.fansmetric.com

GET/v1/whoami

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Response Fields

data.namestring
Human-readable name assigned to the API key when it was created.
data.prefixstring
Public prefix of the API key (e.g. fm_api_hBLridINX1rdl). Safe to log; the full secret is not returned.
data.created_atstring
RFC 3339 timestamp (UTC) of when the API key was issued.
data.rolesarray
Roles assigned to the key. Each entry has id (UUID) and name (e.g. Admin).
data.roles[].idstring
Role UUID.
data.roles[].namestring
Human-readable role name.
data.permissionsarray
Flat list of permission keys granted to this API key (e.g. api_accounts_list, api_messages_send). Each documented endpoint lists the permission it requires.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.name	string	Human-readable name assigned to the API key when it was created.
data.prefix	string	Public prefix of the API key (e.g. `fm_api_hBLridINX1rdl`). Safe to log; the full secret is not returned.
data.created_at	string	RFC 3339 timestamp (UTC) of when the API key was issued.
data.roles	array	Roles assigned to the key. Each entry has `id` (UUID) and `name` (e.g. `Admin`).
data.roles[].id	string	Role UUID.
data.roles[].name	string	Human-readable role name.
data.permissions	array	Flat list of permission keys granted to this API key (e.g. `api_accounts_list`, `api_messages_send`). Each documented endpoint lists the permission it requires.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.com/v1/whoami" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"name":"balaji"
"prefix":"fm_api_hBLridINX1rdl"
"created_at":"2026-05-21T06:55:41.644769Z"
"roles":[0:{"id":"60f125d3-4bee-4983-9f76-a7a52c80393e"
"name":"Admin"
}
]
"permissions":[0:"api_accounts_list"
1:"api_chats_list"
2:"api_messages_send"
3:"api_subscribers_list"
4:"api_tracking_links_list"
5:"api_user_lists_list"
]
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

List Accounts

Health Check