You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.
Chat Members
chat/members@1.0.12 providers
Get workspace members
Retrieve paginated list of members
Input
Workspace
Limit
Page
Result
Members
Next Page
Rate Limit
1.Choose a provider
2.Use GetMembers with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Structure details
Input (object)
workspace
optional
Representation of a workspace. Can be ID or name, depending on the provider capability.
string
limit
optional
Maximum number of records to retrieve
number
page
optional
Page cursor retrieved from nextPage for results pagination
string
Example
Result (object)
members
required
List of retrieved members
list
id
required
Unique identifier of the member
string
username
required
Username identifier of the member
string
joinedAt
optional
UNIX ms timestamp (e.g. 1095379198750) when the member joined workspace
number
isBot
optional
Boolean that represents whether the member is a bot
boolean
nextPage
optional
Cursor to the next page of listing
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of API may have different rate limits.
Bucket identifies to which part of API the rate limits apply.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Timestamp when the rate limits will reset (in Unix Timestamp ms format).
number
resetAfter
optional
Number of seconds until reset of rate limit
number
retryAfter
optional
Number of seconds until user can retry the request
number