Retrieve your API key

GET

/v1/me

GET

/v1/me

Returns the name, company, branches and access of the key you send. It needs no access type, so it is the quickest way to check a key works. It never returns the key itself.

Authorization

bearerAuth

headerAuthorizationBearer <api_key>

Response Body

The key's details

application/json

response

data*

meta*

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/me'

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/me'

Example ResponseSchema

{
  "data": {
    "keyId": "3f9a1c0e7b2d4a58",
    "name": "Supy stock sync",
    "environment": "live",
    "companyId": "YOUR_COMPANY_ID",
    "branchIds": "all",
    "scopes": [
      "company:read",
      "branches:read",
      "transactions:read",
      "payments:read",
      "reports:read"
    ],
    "createdAt": "2026-10-01T08:15:00.000Z",
    "expiresAt": null
  },
  "meta": {
    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"
  }
}

{  "data": {    "keyId": "3f9a1c0e7b2d4a58",    "name": "Supy stock sync",    "environment": "live",    "companyId": "YOUR_COMPANY_ID",    "branchIds": "all",    "scopes": [      "company:read",      "branches:read",      "transactions:read",      "payments:read",      "reports:read"    ],    "createdAt": "2026-10-01T08:15:00.000Z",    "expiresAt": null  },  "meta": {    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"  }}

Retrieve your API key

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body