Who this key is

GEThttps://api.norreach.app/v1/me

The key (prefix, label, scopes, expiry), the person it acts as and their role, the workspace, and which features are on. Use it to check a key works and what it may do.

Any keyOperation id: get_me

GET/me

curl -X GET "https://api.norreach.app/v1/me" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Who this key is

{
  "object": "me",
  "key": {
    "id": "7a1d7f4e-3c1b-4a43-9a64-0d3c1b2f9e10",
    "object": "api_key",
    "kind": "api_key",
    "prefix": "nr_live_8fK2pQ1x",
    "label": "CRM sync",
    "scopes": [
      "contacts:read",
      "contacts:write"
    ],
    "expires_at": null
  },
  "user": {
    "id": "0b6f8a52-8d9e-4c1a-b7f3-5e2d9c4a1b00",
    "object": "user",
    "name": "Alex Andersson",
    "role": "admin"
  },
  "workspace": {
    "id": "5c3e2a10-9b8d-4f6e-a1c2-3d4e5f6a7b8c",
    "object": "workspace",
    "name": "Acme Staffing"
  },
  "features": {
    "landing_pages": true
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. Any valid key works. API keys and scopes

Response

200application/json— Who this key is

object"me"required

keyobjectrequired

Show child attributes

key.idstring (uuid)required

An id (UUID).

key.object"api_key"required

key.kindenumrequired

An API key, or a connected app's grant.

One of:api_keyoauth

key.prefixstringrequired

The first characters of the key (safe to show).

key.labelstring | nullrequired

key.scopesenum[]required

key.expires_atstring | nullrequired

userobjectrequired

The person the key acts as — the person who created it.

Show child attributes

user.idstring (uuid)required

An id (UUID).

user.object"user"required

user.namestring | nullrequired

user.roleenumrequired

The key acts as this person, with this role (read live).

One of:owneradminmanagercaller

workspaceobjectrequired

Show child attributes

workspace.idstring (uuid)required

An id (UUID).

workspace.object"workspace"required

workspace.namestring | nullrequired

featuresobjectrequired

Features that change which operations answer.

Show child attributes

features.landing_pagesbooleanrequired

Hosted landing pages are on for this workspace.

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/me

curl -X GET "https://api.norreach.app/v1/me" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Who this key is

{
  "object": "me",
  "key": {
    "id": "7a1d7f4e-3c1b-4a43-9a64-0d3c1b2f9e10",
    "object": "api_key",
    "kind": "api_key",
    "prefix": "nr_live_8fK2pQ1x",
    "label": "CRM sync",
    "scopes": [
      "contacts:read",
      "contacts:write"
    ],
    "expires_at": null
  },
  "user": {
    "id": "0b6f8a52-8d9e-4c1a-b7f3-5e2d9c4a1b00",
    "object": "user",
    "name": "Alex Andersson",
    "role": "admin"
  },
  "workspace": {
    "id": "5c3e2a10-9b8d-4f6e-a1c2-3d4e5f6a7b8c",
    "object": "workspace",
    "name": "Acme Staffing"
  },
  "features": {
    "landing_pages": true
  }
}