Lists
crm/lists@1.0.12 providers
Get All Lists
Get all available contact lists
Input
Page
Result
lists
Next page
1.Choose a provider
2.Use GetLists with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Copied!
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('crm/lists@1.0.1');
// Use the profile
const result = await profile
.getUseCase('GetLists')
.perform({}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
page
optional
Pagination cursor (obtained from `nextPage`).
string
Example
{}Copied!
Result (object)
lists
optional
list
listId
required
Unique ID of the contact list.
string
name
optional
Name or description of the contact list.
string
length
optional
Amount of contacts in the contact list.
number
nextPage
optional
Next page cursor.
string
Example
{
"lists": [
{
"listId": "foo-bar-1",
"name": "The first list",
"length": 42
}
],
"nextPage": "opaquenextpagetoken"
}Copied!