flexlists-api

Flexlists Client API library for TypeScript

Usage

import the client ;

import { FlexlistsClient, FileImpl } from "flexlists-api";

create the client

const client = new FlexlistsClient(
    "https://my.flexlists.domain.com",
    "Maybe a key"
);

if you do not have a key, you can login

Note: this only works if 2fa is off which is not recommended, so this is only used for testing:

const loginResponse = await client.loginByUser("myuser", "mypass");

get a bearer token for this user

Note: this only works if 2fa is off which is not recommended, so this is only used for testing. Get the same token securily via the website (in your profile).

const loginResponse = await client.getAPIBearerToken();

get the views for a user

const views = await client.getViews();

get the fields for a view:

const fields = await client.getFields(pageRequestListId);

search a list / get content

const contents = await client.search(projectListId);

create an item

await client.create(listId, {content})

Building

• Clone this repository
• Run:

yarn

• Run:

yarn build