Skip to content
Reference

GET /api/v1/me

Who the key belongs to, their tier, wallet count and limit, and the key itself.

The key is read from PORT_API_KEY, so the command never prints it.

curl -s https://getport.app/api/v1/me -H "Authorization: Bearer $PORT_API_KEY"

A 200 with the envelope every endpoint answers, and this endpoint's answer in data. Amounts and USD figures are strings.

What data looks like, with sample values: the shape is the schema's, checked when these pages are built, and the figures are made up, not anyone's port.

{
"userId": "k3Qm8ZtR2vXa9LpW",
"email": "[email protected]",
"tier": "pro",
"walletCount": 14,
"walletLimit": 60,
"key": {
"name": "Spreadsheet",
"hint": "r7Vq",
"mayRefresh": false,
"expiresAt": "2027-01-04T09:12:00.000Z",
"via": "key"
}
}
Field of dataTypeAlways present
userIdstringyes
emailstringyes
tier"free" | "pro"yes
walletCountintegeryes
walletLimitintegeryes
keyobjectyes
The whole schema of data

As the OpenAPI document at https://getport.app/api/v1/openapi.json states it. Objects are left open, because a response only ever gains fields.

{
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"email": {
"type": "string"
},
"tier": {
"type": "string",
"enum": [
"free",
"pro"
]
},
"walletCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"walletLimit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"key": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"hint": {
"type": "string"
},
"mayRefresh": {
"type": "boolean"
},
"expiresAt": {
"type": [
"string",
"null"
]
},
"via": {
"type": "string",
"enum": [
"key",
"sign-in"
]
}
},
"required": [
"name",
"hint",
"mayRefresh",
"expiresAt"
]
}
},
"required": [
"userId",
"email",
"tier",
"walletCount",
"walletLimit",
"key"
]
}

Every endpoint shares three: 401 for a missing or dead key, 402 for an account whose plan has no API ("Agents, MCP and the API are on Pro+ and above."), and 429 past the minute or day limit. The errors section has each body.