Read the calling key

The calling API key, its organization and its owner. scopes lists what the key can do now: its scopes that the owner’s role still allows.

Needs no scope.

GET /me

Read the calling key

cURL

curl --request GET \
  --url https://api.zerogen.com/v1/me \
  --header 'Authorization: Bearer <token>'

200

{
  "apiKey": {
    "id": "<string>",
    "name": "<string>",
    "mode": "live",
    "scopes": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "user": {
    "id": "<string>"
  },
  "sandbox": {
    "projectId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.

Response

200

application/json

The calling key.

apiKey · object · required

Show child attributes

organization · object · required

Show child attributes

user · object · required

The key's owner, whom it acts as

Show child attributes

sandbox · object | null · required

Test keys only: the project every request of the key is confined to

Show child attributes