QuickSwapBrokerService
List my brokers
List the caller's broker memberships and pending invites.
Method
GET
Path
/v1/quickswap/memberships
Visibility
Authentication
Session token
MFA Requirement
Not required
GET
/v1/quickswap/memberships Request
Testnet
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/quickswap/memberships' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"invites": [
{
"accountId": "7563897446546",
"broker": "value",
"brokerDisplayName": "value",
"createdAt": "2025-01-01T00:00:00Z",
"inviteId": "1",
"invitedByAccountId": "7563897446546",
"role": "OWNER"
}
],
"memberships": [
{
"broker": "value",
"brokerDisplayName": "value",
"role": "OWNER"
}
]
} 7 fields
accountId string
Public account ID of the invited person.
Example
7563897446546 broker string
Broker name.
Example
value brokerDisplayName string
Broker display name.
Example
value createdAt string (date-time)
When the invite was sent.
Example
2025-01-01T00:00:00Z inviteId string
Public invite ID.
Example
1 invitedByAccountId string
Public account ID of the member who invited them.
Example
7563897446546 role enum
Role the person gets on accepting.
OWNER ADMIN FINANCE AFFILIATE_MANAGER VIEWER
Example
OWNER 3 fields
broker string
Broker name.
Example
value brokerDisplayName string
Broker display name.
Example
value role enum
The caller's role.
OWNER ADMIN FINANCE AFFILIATE_MANAGER VIEWER
Example
OWNER| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |