Get organization usage overview

/api/v1/me

/api/v1/me

Get organization usage overview

Endpoint

  • Method: GET
  • Path: /api/v1/me

Base URL

https://api.mentionkit.com

Authentication

Use Authorization: Bearer YOUR_API_KEY.

Parameters

No parameters.

Responses

200: Organization summary fetched successfully.

  • Content-Type: application/json
  • Schema: MeResponse
  • Example:
{
  "organization": {
    "id": "org_123",
    "name": "Example Organization",
    "slug": "example-org",
    "logo": null,
    "createdAt": "2026-03-21T00:26:01.515Z"
  },
  "counts": {
    "projects": 1,
    "keywords": 2,
    "trackers": 0,
    "redditKeywords": 2,
    "xKeywords": 0,
    "linkedinKeywords": 0,
    "hnKeywords": 0
  },
  "limits": {
    "projectLimit": 2,
    "reddit": 10,
    "x": 3,
    "linkedin": 1,
    "hn": 10,
    "tokens": 250,
    "trackerLimit": null
  },
  "usage": {
    "projects": {
      "used": 1,
      "limit": 2,
      "remaining": 1
    },
    "redditKeywords": {
      "used": 2,
      "limit": 10,
      "remaining": 8
    },
    "xKeywords": {
      "used": 0,
      "limit": 3,
      "remaining": 3
    },
    "linkedinKeywords": {
      "used": 0,
      "limit": 1,
      "remaining": 1
    },
    "hnKeywords": {
      "used": 0,
      "limit": 10,
      "remaining": 10
    },
    "trackers": {
      "used": 0,
      "limit": null,
      "remaining": null
    }
  }
}

401: Missing or invalid API key.

  • Content-Type: application/json
  • Schema: ErrorResponse

403: API access blocked. The organization is deactivated for API usage and must have an active trial, active paid subscription, or billing exemption.

  • Content-Type: application/json
  • Schema: ErrorResponse
  • Example:
{
  "error": "API access requires a trial, paid subscription, or billing exemption"
}

500: Unexpected server error.

  • Content-Type: application/json
  • Schema: ErrorResponse

Error codes

  • 401: Missing or invalid API key.
  • 403: API access blocked. The organization is deactivated for API usage and must have an active trial, active paid subscription, or billing exemption.
  • 500: Unexpected server error.