Partner account

The partner and the key a request is made with.

Get the key’s partner

GET/v1/partner-api/me

Who the key belongs to, and what it may do. A cheap way to check a key works.

AuthPartner API key

Returns · 200

partnerobjectrequired

Child attributes

idstringrequireduuid

displayNamestringrequired

statusstringrequired

One of onboarding active paused suspended

keyobjectrequired

Child attributes

idstringrequireduuid

namestringrequired

prefixstringrequired

The first characters of the key, safe to show.

scopesarray of stringsrequired

One of reports:read links:read links:write conversions:read

environmentstringrequired

One of production sandbox

expiresAtstringrequireddate-timenullable

Errors

401invalid_api_key: No key was sent, or the key is unknown, expired or revoked.
403partner_suspended: API access is suspended for this partner account.
429rate_limited: Too many requests with this key in the last minute. Wait Retry-After seconds.

Request

curl "https://api.flowgroup.se/v1/partner-api/me" \
  -H "authorization: Bearer $FA_API_KEY"

const res = await fetch('https://api.flowgroup.se/v1/partner-api/me', {
  headers: {
    authorization: `Bearer ${process.env.FA_API_KEY}`,
  },
});
const data = await res.json();

200 OK

{
  "partner": {
    "id": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
    "displayName": "displayName",
    "status": "onboarding"
  },
  "key": {
    "id": "3f1c8a52-6c1e-4b8e-9d0a-2b7f0c4e5a91",
    "name": "name",
    "prefix": "prefix",
    "scopes": [
      "reports:read"
    ],
    "environment": "production",
    "expiresAt": "2026-11-09T12:00:00.000Z"
  }
}

Get the key’s partner#

Get the key’s partner