Skip to content
Docs menu

Show the current user

Credits, today's free quota and whether the key is a sandbox key.

GEThttps://api.switchfile.io/v2/users/me

Needs an API key: Authorization: Bearer YOUR_API_KEY. See Authentication.

Example

curl "https://api.switchfile.io/v2/users/me" \
  -H "Authorization: Bearer $SWITCHFILE_API_KEY"

Responses

  • 200OK
    • dataobjectrequired
    • data.can_convertbooleanrequired
    • data.created_atstringrequired

      ISO 8601 timestamp, for example 2026-11-06T18:00:00+00:00

    • data.creditsstring (integer) | integerrequired

      Paid credits left on the account

    • data.emailstringrequired
    • data.free_quotaobjectrequired
    • data.free_quota.availablebooleanrequired
    • data.free_quota.compute_minutes_per_daynumberrequired
    • data.free_quota.compute_minutes_usednumberrequired
    • data.free_quota.conversions_per_daystring (integer) | integerrequired
    • data.free_quota.conversions_usedstring (integer) | integerrequired
    • data.idstringrequired
    • data.linksobjectrequired
    • data.links.selfstringrequired
    • data.sandboxbooleanrequired
    200 application/json
    {
      "data": {
        "id": "4f8a2c6e-1b3d-4e5f-8a7c-9d0b2e4f6a18",
        "email": "[email protected]",
        "credits": 1200,
        "created_at": "2026-10-01T09:30:00+00:00",
        "free_quota": {
          "conversions_per_day": 50,
          "conversions_used": 3,
          "compute_minutes_per_day": 20,
          "compute_minutes_used": 0.4,
          "available": true
        },
        "can_convert": true,
        "sandbox": false,
        "links": {
          "self": "https://api.switchfile.io/v2/users/me"
        }
      }
    }
  • 401The API key is missing or not valid
    401 application/json
    {
      "message": "Missing or invalid API key.",
      "code": "UNAUTHENTICATED"
    }
  • 404Does not exist for this account
    404 application/json
    {
      "message": "Job not found.",
      "code": "NOT_FOUND"
    }
  • 422Invalid data. errors names the fields
    422 application/json
    {
      "message": "id: Expected string to match 'uuid' format",
      "code": "INVALID_DATA",
      "errors": {
        "id": [
          "Expected string to match 'uuid' format"
        ]
      }
    }
  • 429Too many requests or a daily quota is used up. See Retry-After
    429 application/json
    {
      "message": "Too many requests. Try again in 12 seconds.",
      "code": "RATE_LIMIT_EXCEEDED"
    }

Error bodies and codes are explained in Errors.