Organization / getOrganizations

{
    /** Number of items from the results to skip. Defaults to 0. */
    offset?: number,
    /** Max number of items to return. Defaults to 20. */
    limit?: number,
    /** If specified, determines which items to retrieve. */
    filter?: {
        ids?: string[],
        members?: string[],
        names?: string[],
        searchName?: string
    },
    /** Specifies a field in the returned items to sort by. Defaults to "createdAt". */
    sort?: string,
    sortDirection?: 'asc' | 'desc'
}

{
    /** If successful. One of "result" and "error" will be present. */
    result?: {
        organizations: Organization[],
        /** The total number of organizations that matched the filter. */
        total: number,
        offset: number,
        limit: number
    },

    /** If failed */
    error?: {
        code: 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
    } | {
        code: 'invalid_parameter',
        parameterName: string,
        reason: string
    }
}

Where "Organization" is defined as:

export type Organization = {
    id: string,
    name: string,
    createdAt: number,
    members: {
        userId: string,
        username: string,
        role: 'admin' | 'editor' | 'viewer'
    }[],
    pendingInvites: {
        email: string
    }
}

import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'

let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })

async function main() {
    try {
        let response = await client.organization.getOrganizations()
        if (result.error) {
            // Decthings sent us an error
            console.log(response.error)
        } else {
            // Success!
            console.log(response.result)
        }
    }
    catch (e) {
        // Client throws an error on connection issues. The function may or may not have succeded
        console.log(e)
    }
}
main()