Superface

Chat Members

chat/members@1.0.1
2 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
const { SuperfaceClient } = require('@superfaceai/one-sdk');

// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });

async function run() {
  // Load the profile
  const profile = await sdk.getProfile('chat/members@1.0.1');

  // Use the profile
  const result = await profile
    .getUseCase('GetMembers')
    .perform({
      workspace: '877903817948147752',
      limit: 2
    }, {
      provider: 'mock'
    });

  // Handle the result
  try {
    const data = result.unwrap();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

run();

Structure details

Input (object)

workspace
Representation of a workspace. Can be ID or name, depending on the provider capability.
limit
Maximum number of records to retrieve
page
Page cursor retrieved from nextPage for results pagination

Example

{
  "workspace": "877903817948147752",
  "limit": 2
}

Result (object)

members
List of retrieved members
id
Unique identifier of the member
username
Username identifier of the member
joinedAt
UNIX ms timestamp (e.g. 1095379198750) when the member joined workspace
isBot
Boolean that represents whether the member is a bot
nextPage
Cursor to the next page of listing
rateLimit
Rate limit details.
bucket
Different parts of API may have different rate limits. Bucket identifies to which part of API the rate limits apply.
totalRequests
Total requests available in the time window.
remainingRequests
Remaining requests available in the time window.
remainingRequestsPercentage
Remaining requests available in the time window in percents.
resetTimestamp
Timestamp when the rate limits will reset (in Unix Timestamp ms format).
resetAfter
Number of seconds until reset of rate limit
retryAfter
Number of seconds until user can retry the request

Example

{
  "members": [
    {
      "id": "1",
      "username": "user1",
      "joinedAt": 1643798532134.069
    }
  ]
}

Implementation details

Provider
mock
Use case
GetMembers
Author
@superface
Source
View source
Verified