ClosepactDocs

Account

The API key itself: which organization it belongs to, who it acts as, and what the organization holds.

Endpoints

Inspect the API key

GET/me
Scope read

Returns the key, the organization it belongs to, the member it acts as and the modules the organization holds. Make this your first call: it confirms the key works and shows what it can reach.

curl 'https://api.closepact.com/v1/api/me' \
  -H "Authorization: Bearer $CLOSEPACT_API_KEY"
Response · 200
{
  "data": {
    "api_key": {
      "id": "01a14f2c-7c1e-7d0b-9a3e-3f5b2c8d1e40",
      "name": "CRM sync",
      "prefix": "cp_live_Hx3p",
      "scopes": [
        "read",
        "write"
      ],
      "rate_limit_per_minute": 120,
      "expires_at": null
    },
    "organization": {
      "id": "01a14eb3-c5f0-7c55-8c2e-6a0e1f7b9d21",
      "name": "Nordisk Fastighetsservice AB"
    },
    "acting_as": {
      "id": "01a14eb3-c634-7238-bc76-18b09b287f98",
      "name": "Anna Lindqvist",
      "email": "anna@nordiskfastighet.se"
    },
    "modules": [
      {
        "key": "proposals",
        "tier": "pro",
        "status": "active",
        "writable": true,
        "has_seat": true
      },
      {
        "key": "booking",
        "tier": "grow",
        "status": "trialing",
        "writable": true,
        "has_seat": false
      }
    ]
  }
}

Responses

  • Headers

    • X-RateLimit-Limit — Requests this key may make per minute.
    • X-RateLimit-Remaining — Requests left in the current minute.
    • dataobjectrequired
      • api_keyobjectrequired
      • organizationobjectrequired
      • acting_asobjectrequired

        The member who created the key. The key may do what this member may do, narrowed by its scopes.

      • modulesarray of objectsrequired

        Modules the organization can use (writable) or still read after they lapsed.

  • 401No key, or the key is invalid, revoked or expired, or its creator no longer has access.
    Errors
  • 402The organization has not bought the module this endpoint belongs to, or it has lapsed to read-only, or its tier does not include what the operation needs: feature names the capability (the operation's x-feature) and required_tier the cheapest tier that grants it. Every operation answers this with "feature": "core.api" when no module the organization holds is on a tier that includes the API.
    Errors
  • 403The key lacks the scope, or the member it acts as lacks the permission or holds no seat in the module (module_seat_required — an administrator assigns seats under Settings → Users), or the organization is suspended.
    Errors
  • 429The key has made more requests this minute than its limit allows.
    Errors