List Bots

View as Markdown

Authentication

Authorizationstring

Format: Token <your_api_key>

Query parameters

statusstringOptional
Filter bots by status.
fromdateOptional

Start date for the results, in YYYY-MM-DD format.

todateOptional

End date for the results, in YYYY-MM-DD format.

platformenumOptional

Filter bots by meeting platform. Select one of the supported values; capitalization matters.

Allowed values:
custom_attr[tag]stringOptional

Filter by the custom attribute named tag. Custom attribute filters are combined with AND.

custom_attr[sample]stringOptional

Filter by the custom attribute named sample. Custom attribute filters are combined with AND.

custom_attr[count]doubleOptional

Filter by the numeric custom attribute named count. The value is parsed as JSON and combined with other custom attribute filters using AND.

custom_attr[enabled]booleanOptional

Filter by the boolean custom attribute named enabled. The value is parsed as JSON and combined with other custom attribute filters using AND.

Response

Success
botslist of maps from strings to anyOptional
hasNextPagebooleanOptional
nextCursorstring or nullOptional