Check a key

GET/me

The workspace a key belongs to and its rate limit. Use it to test a connection.

Try itSend a real request with your API key

Answer

200 OK The key’s workspace.

dataMeRequired
Inside it
- workspaceWorkspaceRequired
  Inside it
  - idstringRequired
    The workspace ID. Events carry the same one.
  - namestringRequired
    The workspace’s name.
- keyobjectRequired
  Inside it
  - idstringRequired
    The key’s ID.
  - namestringRequired
    The name given to the key in Salesteam.
- rateLimitobjectRequired
  Inside it
  - limitintegerRequired
    Requests allowed per window.
  - windowSecondsintegerRequired
    Window length in seconds.

Errors

401 Unauthorizedunauthorized
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

GET /me

curl "https://app.salesteam.dev/api/v1/me" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY"

const response = await fetch("https://app.salesteam.dev/api/v1/me", {
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
  },
});
console.log(response.status, await response.json());

import os
import requests

response = requests.get(
    "https://app.salesteam.dev/api/v1/me",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}"},
)
print(response.status_code, response.json())

200 answer

{
  "data": {
    "workspace": {
      "id": "ws_5f2a9c0e7b14d3a6c8e1f027",
      "name": "Acme outbound"
    },
    "key": {
      "id": "key_Ab12Cd34Ef56Gh78",
      "name": "Zapier"
    },
    "rateLimit": {
      "limit": 300,
      "windowSeconds": 60
    }
  }
}