# List Address

## <mark style="color:blue;">GET</mark> /api/v1/listAddress

* Note: It is for querying a user's list of Web3 addresses
* Header

| Field         | Type   | Required | Remarks                                                                                                  |
| ------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------- |
| ApiKey        | String | true     | [ApiKey](https://relationlabs.gitbook.io/relation-one-api/guide/glossary#ApiKey) acquired from the admin |
| Authorization | String | false    | Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is the result returned by /api/v1/auth        |

* Request Parameters

| Field      | Type   | Remarks    |
| ---------- | ------ | ---------- |
| relationId | String | relationId |

* Request Example

```shell
curl  GET 'https://api.relationlabs.ai/api/v1/listAddress?relationId=d4swz-zaaaa-aaaaj-at5fa-cai' \
--header 'ApiKey: <ApiKey>'
```

* Response Parameters

| Field | Type               | Remarks            |
| ----- | ------------------ | ------------------ |
| code  | String             | the Return Code    |
| desc  | String             | the Return Message |
| data  | List\[AddressInfo] | the Data           |

The AddressInfo field consists of the following subfields:

| Field   | Type   | Remarks             |
| ------- | ------ | ------------------- |
| address | String | user's web3 address |

* Response Body

```json
{
    "code": "0",
    "desc": "success",
    "data": [
        {
            "address": "0x9bd286ef4e3d9ec1af6c6ae9da2f0b3617deab13"
        }
    ]
}
```

* Return Code

| code | desc    | Remarks                           |
| ---- | ------- | --------------------------------- |
| 0    | success | the flag for a successful request |