Documentation

Mistake on this page? Email us

Index

Type aliases

ObjectEnum

ObjectEnum: "list"

OrderEnum

OrderEnum: "ASC" | "DESC"

Properties

after

after: string

The entity ID to fetch after the given one.

data

data: Array<GroupSummary>

A list of entities.

has_more

has_more: boolean

Flag indicating whether there is more results.

limit

limit: number

The number of results to return, (range: 2-1000), or equals to total_count

object

object: ObjectEnum

Entity name: always 'list'

order

order: OrderEnum

The order of the records to return based on creation time. Available values: ASC, DESC; by default ASC.

total_count

total_count: number

The total number or records, if requested. It might be returned also for small lists.