Check credentials

GET

/v1/me

Returns the company, scopes and type of these credentials. Needs no scope, so use it to test a key or token.

Errors

401Invalid or missing authentication
403Missing scope, or the company is archived
404The resource does not exist in this company
429Rate limit exceeded

Every error has the same shape. See Errors.

cURL

curl https://api.numina.app/v1/me \
  -H "Authorization: Bearer numi_YOUR_API_KEY"

JavaScript

const response = await fetch("https://api.numina.app/v1/me", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.NUMINA_API_KEY}`,
  },
});

const data = await response.json();

Python

import os

import requests

response = requests.get(
    "https://api.numina.app/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['NUMINA_API_KEY']}",
    },
)
data = response.json()

Response

200

{
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "string",
    "first_name": "string",
    "last_name": "string"
  },
  "company": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "string",
    "slug": "string"
  },
  "scopes": [
    "contacts:read",
    "invoices:read"
  ],
  "auth_type": "oauth"
}