For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Info

Verify the authenticated Blotato user, subscription information, and account usage through REST.

Users

General

Use these endpoints to verify your API key and check account usage.

Endpoints

GET /v2/users/me

Fetches the current user's information, including subscription status and plan. This endpoint is useful for verifying that your API key is valid and referencing your own userId.

Response Keys

Name
Type
Description

id

string

The unique ID of the user.

subscriptionStatus

string

The user's subscription status (e.g., active, generic_pro).

subscriptionPlan

string

The user's plan tier: starter, creator, or agency.

apiKey

string

[Sensitive] The user's API key.


Examples

Get verification info

Response 200 OK


GET /v2/users/me/usage

Returns the current user's connected-account usage, active-contact usage, and active-contact limit.

Use this endpoint before connecting more accounts or sending messages at scale so you know how close you are to your plan limits. For the limit values on each plan, see Plan Limits.

Response Keys

Name
Type
Description

accounts

integer

Number of connected channels counting toward the connected-accounts limit. Facebook Pages count. The Facebook login itself does not count. LinkedIn profiles and LinkedIn company Pages count.

contacts

integer

Number of contacts messaged this month, counting toward the active-contacts limit.

contactsLimit

integer or "unlimited"

Maximum active contacts you can message this month. This matches your current account limit, including any custom active-contact limit on your account.

Get usage

Response 200 OK

Last updated