GET
/
v1
/
access-management
/
invited
List invites you have sent
curl --request GET \
  --url https://api.next.orenda.finance/v1/access-management/invited \
  --header 'Authorization: Bearer <token>' \
  --header 'x-program-id: <api-key>'
const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-program-id': '<api-key>'}
};

fetch('https://api.next.orenda.finance/v1/access-management/invited', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://api.next.orenda.finance/v1/access-management/invited"

headers = {
"Authorization": "Bearer <token>",
"x-program-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
{
  "success": true,
  "data": [
    {
      "applicantInformationName": "Ada Lovelace",
      "email": "ada.lovelace@example.com",
      "customerId": "cust_3f9a2b7e",
      "identity": "ada.lovelace@example.com",
      "accounts": [
        {
          "accountId": "acc_4e8a1c6d",
          "accountName": "Ada Lovelace - GBP",
          "status": "ACTIVE",
          "currency": "GBP"
        }
      ],
      "cards": [
        {
          "id": "card_2a7f9b3e",
          "status": "ACTIVE",
          "type": "VIRTUAL",
          "currency": "GBP",
          "maskedPan": "453245******7821",
          "nickName": "Ada travel",
          "provider": "interlace",
          "providerCardId": "ic_8821ab",
          "providerBalance": 250.75
        }
      ]
    },
    {
      "applicantInformationName": "Grace Hopper",
      "email": "grace.hopper@example.com",
      "customerId": "cust_7b1d4e9a",
      "identity": "grace.hopper@example.com",
      "accounts": [],
      "cards": []
    }
  ],
  "totalCount": 2,
  "limit": 50,
  "nextToken": null
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

x-program-id
string
header
required

The program the request acts on.

Query Parameters

limit
integer
default:50

Page size (default 50).

nextToken
string

Cursor from the previous page's response.

Response

Paginated invited customers

success
boolean
Example:

true

data
object[]
totalCount
integer
limit
integer
nextToken
string

Cursor for the next page; absent when there are no more results.