Get a client account

Parameters

---

No parameters

Returns

Returns: ClientAccount object

idstringrequired

The Account's unique identifier

---

namestringrequired

The Account's name

---

organisation_idstringrequired

The unique identifier of the organisation this account belongs to

---

handlestring^[a-z0-9-_]+$required

handle is a client defined URL-friendly string that identifies the account.

The handle is unique per organisation and account type.

---

currencyenumrequired

The account's currency.

ISO 4217 3 character currency code.

Note: Lune does not support all currency codes.

Enum:

• GBP
• EUR
• USD
• SEK
• CHF
• PLN
• DKK
• NOK
• BGN
• INR
• SGD
• AED
• AUD
• HUF
• ISK
• CZK
• CAD

---

typeenumrequired

The account's type.

Enum:

• live
• test

---

logostringrequired

The account logo

---

beneficiarystringrequired

Retirement beneficiary

This is the name that appears on future retirements that are made in this account. If none is present, the organisation beneficiary will be used instead.

---

bundle_portfolio_idstringrequired

Bundle portfolio id tied to the account.

---

external_pages_visibilityenumrequired

Enum to control the visibility of external pages such as sustainability and analytics pages.

Enum:

• public
• hidden

GET /accounts/client/me

curl 'https://api.lune.co/v1/accounts/client/me' \
  -H 'Authorization: Bearer <API_KEY>'

Response

{
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "name": "ACME",
  "beneficiary": "ACME Inc",
  "currency": "USD",
  "type": "live",
  "organisation_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
  "logo": null,
  "bundle_portfolio_id": null
}