Have ideas to improve npm?Join in the discussion! »

    clubhouse-lib
    TypeScript icon, indicating that this package has built-in type declarations

    0.12.0 • Public • Published

    Clubhouse logo

    Clubhouse-lib

    A library for interacting with the Clubhouse REST API

    Current npm package version. Current CircleCI build status. PRs welcome! Follow @clubhouse


    Getting Started

    Installation

    You can install clubhouse-lib with NPM or Yarn.

    npm install --save clubhouse-lib

    or

    yarn add clubhouse-lib

    How to Get an API Token

    The Clubhouse API uses token-based authentication, you will need one to use this library.

    To generate an API token, go to https://app.clubhouse.io/settings/account/api-tokens. To make it easier to explore our API, we recommend saving this token as an environment variable in your local dev environment:

    export CLUBHOUSE_API_TOKEN="YOUR API TOKEN HERE"

    This will allow you to copy and paste many examples in the documentation to try them out.

    Requests made with a missing or invalid token will get a 401 Unauthorized response. All requests must be made over HTTPS. Tokens provide complete access to your Clubhouse account, so keep them secure. Don’t paste them into your source code, use an environment variable instead. For security reasons, we will immediately invalidate any tokens we find have been made public.

    Usage

    import Clubhouse from 'clubhouse-lib';
    
    const client = Clubhouse.create('your token value'); // See https://github.com/clubhouse/clubhouse-lib#how-to-get-an-api-token
    
    client.listMembers().then(console.log);
    
    client.getMember('')
      .catch(x => console.error(x.body))
      .then(console.log);
    
    client.listProjects().then(console.log);

    Play with It

    You can play with it in your web browser with this live playground:

    Documentation

    Documentation for the REST API.

    Keywords

    none

    Install

    npm i clubhouse-lib

    DownloadsWeekly Downloads

    1,317

    Version

    0.12.0

    License

    MIT

    Unpacked Size

    59 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar