List Account Invites

Request URL

GET /invites/foraccount/:AFiAccountId

Description

Get account invites sent for a specific account. The account is identified by a path parameter.

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'GET',
  url: '${AMPLIFI_BASE_URL}/invites/foraccount/:AFiAccountId',
  headers: {
    'token': "A long random string token received from /token request"
  },
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "AMPLIFI_BASE_URL/invites/foraccount/:AFiAccountId"  --header "token: A long random string token received from /token request" 

Successful Response Examples

200 INVITES/FORACCOUNT/:AFIACCOUNTID SUCCESSFUL RESPONSE GET INVITES FOR SPECIFIED ACCOUNT

HEADERS

Header	Value
token	A long random string token received from /token request

PARAMETERS

Parameter	Description	Value
AFiAccountId	[required]	qwegal8kgtmysmels

REQUEST BODY

none

RESPONSE BODY

{
    "success": true,
    "invites": [
        {
            "AFiInviteId": "qwechytbbgbyyyfwamwquprtqibrrbtaezvukvxocbd",
            "AFiUserId": "qweaurl8kgtlv9pc",
            "AFiAccountId": "qwegal8kgtmysmels",
            "AFiCardId": "qwegal8kgtmysmels",
            "role": "test",
            "familyMemberType": null,
            "linklink": "AAORSLADF",
            "firstName": "Suzy",
            "lastName": "Queue",
            "dtsCreated": "2023-12-15T12:39:20.402Z",
            "dtsExpiry": "2023-12-17T12:39:20.402Z",
            "isActive": true
        }
    ]
}