Acquainto
← API reference

Me

GET/v1/me

Retrieve the current credential

Confirms a credential works and reports what it can do. Costs one query and requires no scope — use it as a health check for your integration.

Example request

curl https://api.acquainto.com/v1/me \
  -H "Authorization: Bearer acq_live_xxxxxxxx"

Responses

200Retrieve the current credential
  • tenantobjectrequired
    • idstringrequired

      A tenant id, prefixed `tnt_`.

    • namestringrequired
    • planstringrequired
  • credentialobjectrequired
    • idstringrequired

      A credential id, prefixed `cred_`.

    • type"api_key" | "oauth"required
    • mode"live" | "test"required

      `test` keys are sandboxed. Currently every key is `live`.

    • scopesarray of stringrequired

      What this credential may do. A route you lack the scope for returns 403 `insufficient_scope`.

  • rateLimitsarray of objectrequired

    Limits currently governing this credential. Empty today: no per-credential rate limit or quota applies to /v1 yet. Do not read an empty list as "unlimited" -- treat it as "no published limit", and keep your retry handling for 429 in place.

    • namestringrequired

      Which limit this is.

    • limitintegerrequired

      Requests permitted per window.

    • remainingintegerrequired
    • windowSecondsintegerrequired
    • resetsAtstringrequired
  • usageobjectrequired
    • requestsTodayintegerrequired

      Authenticated requests from your tenant since 00:00 UTC, across both this API and the dashboard -- not only your own calls.

    • requestsLast30Daysintegerrequired

      The same total over the trailing 30 days.

400The request was malformed or failed validation.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

401Missing, invalid, or revoked credential.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

403The credential lacks the scope this route requires.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

429Rate limited. Retry after the interval in `Retry-After`.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

500Something failed on our side. Safe to retry.
  • errorobjectrequired
    • type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required

      The bucket a client branches on to decide how to react.

    • codestringrequired

      Stable machine-readable code. Branch on this, not on `message`.

    • messagestringrequired

      Human-readable. May change without notice.

    • paramstring

      The offending request field, when the error names one.

    • requestIdstringrequired

      Echoes the `req_...` id; quote it in support requests.

Browse every operation, with full request/response schemas, in the full API reference.