Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Member Management
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
      • Invite members
        POST
      • Delete member
        POST
      • Reset information
        POST
      • Member list
        POST
    • Team Management
      • Team list
      • Basic information
      • Delete team
      • Team upsert
    • Schedule Management
      • Preview schedule
      • Update schedule
      • Enable schedule
      • Disable schedule
      • Create schedule
      • Delete schedule
      • View schedule details
      • Get schedule information by ID list
      • View schedule list
      • Personal schedule calendar
      • Role information
    • Information Retrieval
      • Channel
      • Member
      • Team
    • Preference Settings
      • View preference settings
      • Modify preference settings
    • Channel
      • Escalation Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Create rule
        • Update rule
      • Subscription Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Drop Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Silence Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Inner conditions
      • Inhibit Rules
        • Disable rule
        • Delete rule
        • Rule list
        • See creation interface for filters explanation
        • Channel ID
        • Rule name
      • Match conditions
      • Delete rule
      • See creation interface for filters explanation
      • Enable rule
      • Update rule
      • Rule ID
      • Rule name
      • Sort
      • Delete rule
      • See creation interface for filters explanation
      • Name by integration
      • Robot list
    • Template Management
      • Name
      • Enable rule
      • Delete rule
      • See creation interface for filters explanation
      • Channel ID
      • Rule name
      • Required when updating
      • Update rule
    • Incident Management
      • Group View
        • Channel
        • Rule name
        • Inner conditions
        • Channel
      • Match conditions
      • Enable rule
      • Disable rule
      • Delete rule
      • Rule list
      • See creation interface for filters explanation
      • Create rule
      • Rule description
      • Update rule
      • Channel
      • Match conditions
      • Match conditions
      • Update rule
      • Channel
      • Rule ID
      • Inner conditions
      • Enable rule
      • Rule list
      • Rule details
      • Rule name
      • Rule description
      • Match conditions
      • Rule description
      • See creation interface for filters explanation
      • Disable rule
      • Rule description
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Alert Info
      • Close Alert
      • Alert List By Card
      • Alert List
      • Alert List By ID
      • Event List
      • Feed
      • Merge Incident
    • Change Management
      • Inner conditions
    • Insights (old)
      • Channel
      • Match conditions
      • Rule ID
      • Enable rule
      • Name
      • Disable rule
      • Rule name
      • Name
      • See creation interface for filters explanation
    • Custom Fields
      • Enable rule
      • Disable rule
      • See creation interface for filters explanation
      • Channel ID
      • Channel
    • Service Calendar
      • Match conditions
      • Delete rule
      • Update rule
      • Required when updating
      • Rule details
      • Required when updating
      • Inner conditions
      • Channel
    • Label Enhancement
      • Mapping
        • Rule name
        • Rule list
        • Rule description
        • Match conditions
        • Rule ID
        • Rule description
        • Inner conditions
        • Enable rule
        • Disable rule
        • Rule description
      • Enable rule
      • Delete rule
    • Alert Processing
      • Create rule
      • Rule name
    • Integration Routing
      • Required when updating
      • Rule description
      • Match conditions
    • License Management
      • Create rule
    • Insights
      • Team Metrics
      • Responder Metrics Export
      • Incident List
      • Responder Metrics
      • Account Metrics
      • Channel Metrics Export
      • Team Metrics Export
      • Incident Export
      • Alert Top
      • Cahnnel Metrics
  • Event API
    • Quick Start
    • Alert Event
    • Change Event
  • Webhook
    • Quick Start
    • Custom Actions
    • Alert Webhook
    • Incident Webhook
  1. Member Management

Member list

POST
/member/list

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
p
integer 
Page number, starts from 1
optional
limit
integer 
Items per page
optional
asc
boolean 
Ascending order
optional
orderby
string 
Sort by created_at or updated_at
optional
role_id
integer 
Role ID
optional
query
string 
Search keyword
optional
Currently only fuzzy search for member_name
Example
{
    "p": 0,
    "limit": 0,
    "asc": true,
    "orderby": "string",
    "role_id": 0,
    "query": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/member/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "p": 0,
    "limit": 0,
    "asc": true,
    "orderby": "string",
    "role_id": 0,
    "query": "string"
}'

Responses

🟢200成功
application/json
Body
error
object (DutyError) 
optional
code
enum<string> 
Rule description
required
Allowed values:
InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist
message
string 
Inner conditions
required
data
object 
optional
p
integer 
required
limit
integer 
required
total
integer 
required
items
array[object (MemberItem) {13}] 
required
Example
{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "p": 0,
        "limit": 0,
        "total": 0,
        "items": [
            {
                "member_id": 0,
                "member_name": "string",
                "phone": "string",
                "phone_verified": "string",
                "email": "string",
                "email_verified": "string",
                "account_role_ids": [
                    0
                ],
                "time_zone": "Asia/Shanghai",
                "locale": "zh-CN",
                "status": "string",
                "created_at": 0,
                "updated_at": 0,
                "ref_id": "string"
            }
        ]
    }
}
Modified at 2025-01-22 10:14:38
Previous
Reset information
Next
Team list
Built with