> For the complete documentation index, see [llms.txt](https://doc.mantago.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.mantago.cc/wen-jian-shuo-ming-1/hui-yuan-api/hui-yuan-lie-biao.md).

# 會員列表

## Get client list

> Retrieve a list of clients with pagination support

```json
{"openapi":"3.0.3","info":{"title":"Manta OpenAPI","version":"0.363.10"},"tags":[{"name":"Core","description":"Core OpenAPI functionality for customer management and broadcasting"}],"servers":[{"url":"https://mantago.cc/api","description":"MantaGo Openapi host url"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for API authentication"}},"schemas":{"SecretRequest":{"type":"object","properties":{"secret":{"type":"string","description":"Secret key for API authentication"}},"required":["secret"]},"ClientListResponse":{"allOf":[{"$ref":"#/components/schemas/BasicSuccessResponse"},{"type":"object","properties":{"clientList":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"next":{"type":"string","description":"Next page token for pagination"}}}}}]},"BasicSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success","message"]},"Client":{"type":"object","properties":{"clientId":{"type":"string","description":"Platform-specific client ID"},"clientName":{"type":"string","description":"Client display name"},"clientHeadshot":{"type":"string","format":"uri","description":"Client avatar URL"},"platform":{"type":"string","enum":["line","facebook","instagram","liveChat","whatsapp"],"description":"Platform type"},"remark":{"type":"string","description":"Admin remarks about the client"},"isBlock":{"type":"boolean","description":"Whether the client is blocked"},"customerId":{"type":"string","description":"Internal customer ID"},"userName":{"type":"string","description":"User's questionnaire name"},"userEmail":{"type":"string","format":"email","description":"User's questionnaire email"},"userPhone":{"type":"string","description":"User's questionnaire phone"},"userBirthday":{"type":"string","format":"date","description":"User's questionnaire birthday"},"userAddress":{"type":"string","description":"User's questionnaire address"},"createdAt":{"type":"string","format":"date-time","description":"Client creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Client last update timestamp"},"lastInteractAt":{"type":"string","format":"date-time","description":"Last interaction timestamp"},"autoTags":{"type":"array","items":{"$ref":"#/components/schemas/TagInfo"},"description":"Auto tags assigned to client"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagInfo"},"description":"Client tags assigned to client"},"tourTags":{"type":"array","items":{"$ref":"#/components/schemas/TagInfo"},"description":"Tour management tags assigned to client"},"personalTags":{"type":"array","items":{"$ref":"#/components/schemas/TagInfo"},"description":"Personal tags assigned to client"}}},"TagInfo":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"createdAt":{"type":"string","format":"date-time","description":"Tag creation timestamp"}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"errResponse":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer"},"botId":{"type":"string"}},"required":["message","code"]}},"required":["success","errResponse"]}},"responses":{"TokenError":{"description":"JWT token is invalid or expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"PermissionError":{"description":"Permission denied - insufficient access rights","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimitError":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/openapi/clients":{"post":{"tags":["Core"],"summary":"Get client list","description":"Retrieve a list of clients with pagination support","parameters":[{"name":"botId","in":"query","required":true,"schema":{"type":"string"},"description":"The bot ID for the API request"},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by customer ID"},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["line","facebook","instagram","liveChat","whatsapp"]},"description":"Filter by platform"},{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by client name"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10},"description":"Maximum number of clients to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0},"description":"Number of clients to skip"},{"name":"startAt","in":"query","required":false,"schema":{"type":"integer"},"description":"Start timestamp (1657867028700) for filtering clients"},{"name":"endAt","in":"query","required":false,"schema":{"type":"integer"},"description":"End timestamp (1657867028700) for filtering clients"},{"name":"next","in":"query","required":false,"schema":{"type":"string"},"description":"Pagination token for next page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretRequest"}}}},"responses":{"200":{"description":"Client list retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientListResponse"}}}},"400":{"description":"Invalid date parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/TokenError"},"403":{"$ref":"#/components/responses/PermissionError"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/RateLimitError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```