Get Directly Invited User List

API Description

This interface retrieves the list of users directly invited by the currently authenticated affiliate user.

The affiliate user identity is automatically determined through OpenAPI authentication. Only directly invited users are returned. Users invited under downstream affiliate users are not included.

Precautions

1. Request parameters startTime and endTime must use the format yyyy-MM-dd HH:mm:ss.
2. For GET requests, all request parameters must be passed as URL query parameters instead of in the request body.
3. If startTime is not provided, it defaults to the beginning of the current month.
4. If endTime is not provided, it defaults to the end of the current month.
5. Results are sorted in descending order by register_time, then by id for stable sorting.
6. Default pageSize is 100, and the maximum is 1000.

Authentication

This is a private interface and requires authentication. For details on using the RESTful API, refer to Introduction > Authentication & Signature.

Request Method

GET

Endpoint

/api/v3/patener/openapi/v1/partner/invitation/user/list

Request Parameters

Parameter	Mandatory	Type	Description
startTime	false	String	Start time, formatted as yyyy-MM-dd HH:mm:ss, filtered by registration time. Defaults to the beginning of the current month if not provided.
endTime	false	String	End time, formatted as yyyy-MM-dd HH:mm:ss, filtered by registration time. Defaults to the end of the current month if not provided.
pageNo	false	Integer	Page number. Default: 1.
pageSize	false	Integer	Number of records per page. Default: 100. Maximum: 1000.
uid	false	Long	Query a specific invited user by UID.
referralCode	false	String	Filter users registered using the specified referral code.

Response Parameters

Parameter	Type	Description
data.list[].uid	Long	Invited user UID
data.list[].registerTime	String	Registration time, formatted as yyyy-MM-dd HH:mm:ss
data.total	Long	Total number of records

Request Example

params = {
  "pageNo": 1,
  "pageSize": 100,
  "uid": 1116977,
  "startTime": "2021-09-09 13:43:18",
  "endTime": "2021-09-09 14:43:18"
}

api_url = "/api/v3/patener/openapi/v1/partner/invitation/user/list"

method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)  # function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

Response Example

{
  "code": "200",
  "msg": "success",
  "data": {
    "list": [
      {
        "uid": 1116977,
        "registerTime": "2021-09-09 14:43:18"
      }
    ],
    "total": 1
  }
}