Assistants

List assistants

Fetch all assistants for a specific org.

get/orgs/assistants

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/assistants
  • Auth: HTTP bearer

Query parameters

searchstring

Filter assistants by name.

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

An array of assistants.

idstring required
namestring required

The name of the assistant

deletedboolean required

Whether the assistant has been soft-deleted

secret_keystring nullable required

The secret key to create session hashes

avatar_urlstring nullable required

The URL of the avatar photo

members_countnumber

Total number of assigned members (list reads only)

created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.