NisuformDocs

Account API

Check an API key and read the account, team, plan and monthly usage it works with through GET /v1/me.

GET https://api.nisuform.com/v1/me

Returns the account that owns the key and the team the key works in. Call it to check that a key is valid, or to read the team's usage before a big job.

curl https://api.nisuform.com/v1/me \
  -H "Authorization: Bearer $NISUFORM_API_KEY"
{
  "id": "5b1e0c7a-2f64-4d3b-9a1e-8c7d6f5e4b3a",
  "email": "jane@example.com",
  "username": "jane",
  "avatarUrl": null,
  "createdAt": "2026-09-01T08:00:00.000Z",
  "plan": "pro",
  "usage": { "used": 1240, "limit": 5000 },
  "formLimit": null,
  "activeTeamId": "2f6b7c1e-9a4d-4c3e-8b21-7d5e6f4a3b2c",
  "teams": [
    {
      "id": "2f6b7c1e-9a4d-4c3e-8b21-7d5e6f4a3b2c",
      "name": "Acme",
      "role": "owner",
      "plan": "pro",
      "isPersonal": false,
      "avatarUrl": null
    }
  ]
}

Fields

FieldTypeDescription
idstringYour user ID.
emailstringYour email address.
usernamestring or nullYour username.
avatarUrlstring or nullYour profile picture.
createdAtstringWhen you signed up.
planfree or proThe plan of the key's team.
usage.usednumberSubmissions the team received this month, across its forms.
usage.limitnumberThe team's monthly submission limit.
formLimitnumber or nullHow many forms the team can have, or null for no limit on Pro.
activeTeamIdstringThe team the key works in.
teamsarrayOnly the key's team, with its id, name, your role (owner or member), plan, isPersonal and avatarUrl.

Usage resets on the first day of each month in UTC. See Limits for the numbers on each plan.

On this page