Account | API Reference Guide | CourtMesh
    Skip to main content
    On this page

    Account

    Check your usage, confirm which key and account you are calling as, and pull the audit log for your organisation or yourself.

    Account endpoints
    Identity, usage and audit. Neither GET /me nor GET /audit is metered.
    GET

    /usage

    0 creditsUnmetered

    Your own tier, balance, per tier limits and per endpoint call counts for the current billing period. Checking it never itself burns a credit: the handler passes { skip: true } to the billing layer, the same convention GET /me and GET /audit use. Requires a key like every other account-introspection endpoint on this page; it is unmetered, not public.

    curl https://research.courtmesh.ai/api/v1/prod/usage \
  -H "X-API-Key: cm-YOUR_KEY_HERE"
    GET

    /me

    Unmetered

    Identity behind the key: user identifier, email, name, role, and the organisation identifier when the account belongs to one. Call it first if you plan to use /audit, which needs one of those two identifiers. The organizationId field is absent, not null, for accounts with no organisation.

    Currently unmetered. This endpoint is not in the priced endpoint list, so it settles at zero credits even after the self serve ladder is switched on. It still needs a valid key, still passes the Enterprise entitlement gate, and still consumes a rate limit slot. Treat the zero price as today's behaviour rather than a commitment.

    curl https://research.courtmesh.ai/api/v1/prod/me \
  -H "X-API-Key: cm-YOUR_KEY_HERE"
    GET

    /audit

    Unmetered

    Your own API usage log: every call with its endpoint, method, status code, response time, credits deducted, client address and user agent, plus a summary block and a top endpoints breakdown. You must pass either organizationId or userId; sending neither is a validation error.

    Currently unmetered, on the same footing as /me: absent from the priced endpoint list, so it settles at zero credits while still requiring a valid key and consuming a rate limit slot.

    Query parameters

    FieldTypeRequiredNotes
    organizationIdstringNoOrganisation to report on. Either this or userId is required; sending neither returns HTTP 400. You must belong to the organisation you ask about.
    userIdstringNoUser to report on. You can only ask about yourself unless you are an ORG_ADMIN and the user is in your organisation.
    limitnumberNoRecords per page, default 50, maximum 200.
    offsetnumberNoPagination offset, default 0, cannot be negative.
    startDatestringNoISO 8601 timestamp, for example 2026-01-01T00:00:00Z. A plain date is rejected with HTTP 400.
    endDatestringNoISO 8601 timestamp, for example 2026-12-31T23:59:59Z.
    # By organisation
curl "https://research.courtmesh.ai/api/v1/prod/audit?organizationId=507f1f77bcf86cd799439011&limit=50&offset=0" \
  -H "X-API-Key: cm-YOUR_KEY_HERE"

# By user, with a date range
curl "https://research.courtmesh.ai/api/v1/prod/audit?userId=507f1f77bcf86cd799439012&startDate=2026-01-01T00:00:00Z&endDate=2026-06-30T23:59:59Z" \
  -H "X-API-Key: cm-YOUR_KEY_HERE"

    Access control

    • You can always read your own usage
    • Reading another user's usage requires the ORG_ADMIN role and that user being in your organisation
    • Asking about an organisation requires you to be in it, and the refusal message tells you your own organisation identifier so you can correct the call
    • creditsDeducted reads 0 on every row today, because API credit settlement is inert while the self serve ladder is off
    PreviousCoverage and reference
    NextSDKs and tools