Staffbase icon

Staffbase

Employee-experience intranet and mobile app built for frontline and desk workers.

10 triggers22 searches27 actionsPollingAuth: API key

AI-assisted documentation21 min read

This documentation is compiled from our integration source code, internal specs for Staffbase, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Staffbase on WEXTL →

Before you set up the credential, make sure you have an active Staffbase account and an API access token from your account settings ready.[3]

  • SubdomaintextRequired

    Open Staffbase Studio in your browser, look at the URL in the address bar and copy the part before .staffbase.com.

    [1]
  • API KeypasswordRequired

    Create an API token in Staffbase Studio under Settings → API Access by naming it and selecting permissions, then copy the generated token from the API Tokens page to use for authentication.

    [1]
  1. Log in to your WEXTL account, add the Staffbase node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Staffbase account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch CollectionTrigger
Output fields[3]
FieldType
IDtext
Nametext
Accessor idsarray
Admin idsarray
Medium countnumber
Created atdate
Updated atdate
Watch Collection FilesTrigger
Output fields[3]
FieldType
IDtext
Createddate
Created byobject
IDtext
First nametext
Last nametext
Mime typetext
Typetext
Originalobject
Sizenumber
Heightnumber
Widthnumber
URLurl
File nametext
File extensiontext
Reference countnumber
Playback URLtext
Durationnumber
Thumbnailobject
URLtext
Widthnumber
Heightnumber
Watch CommentsTrigger
Output fields[3]
FieldType
IDtext
Installation IDtext
Parent IDtext
Parent typetext
Author IDtext
Publishedboolean
Texttext
Authorobject
Entity typetext
First nametext
IDtext
Last nametext
Root IDtext
Linksobject
Unpublishobject
Deleteobject
Rightsarray
Entity typetext
Updateddate
Createddate
Watch CSV ImportsTrigger
Output fields[3]
FieldType
IDtext
Created atdate
File nametext
File sizenumber
Record countnumber
Statetext
Ownerobject
Owner IDtext
Typetext
Watch FilesTrigger
Output fields[3]
FieldType
IDtext
Createdtext
Created byobject
IDtext
First nametext
Last nametext
Mime typetext
Typetext
Originalobject
Sizenumber
Heightnumber
Widthnumber
URLurl
File nametext
File extensiontext
Reference countnumber
Playback URLurl
Durationnumber
Thumbnailobject
URLurl
Widthnumber
Heightnumber
Watch Group MembersTrigger
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Watch GroupsTrigger
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Watch PagesTrigger
Output fields[3]
FieldType
IDtext
Created atdate
Updated atdate
Is outdatedboolean
Contentsobject
En usobject
De deobject
Owner IDtext
Space IDtext
Readersobject
User idsarray
Adminsobject
User idsarray
Group idsarray
Token idsarray
Watch User GroupsTrigger
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Watch UsersTrigger
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Get a CollectionAction
Input fields[3]
FieldType
Collection IDRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Accessor idsarray
Admin idsarray
Medium countnumber
Created atdate
Updated atdate
Get a GroupAction
Input fields[3]
FieldType
Group IDRequired
choice
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Get a PageAction
Input fields[3]
FieldType
Page IDRequired
choice
Output fields[3]
FieldType
IDtext
Owner IDtext
Contentsobject
En usobject
De deobject
Space IDtext
Branch IDtext
Created atdate
Updated atdate
Published atdate
Readersobject
User idsarray
Branch accessboolean
Adminsobject
User idsarray
Group idsarray
Token idsarray
Get a UserAction
Input fields[3]
FieldType
User IDRequired
choice
Include Profileboolean
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Get CSV Import ConfigurationAction
Input fields[3]
FieldType
Import IDRequired
choice
Output fields[3]
FieldType
Deltaboolean
Encodingtext
Generate recovery codesboolean
Partial tagtext
Report mail addresstext
Report only on errorsboolean
Send mails newboolean
Send mails pendingboolean
Separatortext
Typetext
Mappingobject
External IDtext
Profile field:first nametext
Profile field:last nametext
Get CSV Import MetadataAction
Input fields[3]
FieldType
Import IDRequired
choice
Output fields[3]
FieldType
IDtext
Created atdate
File nametext
File sizenumber
Record countnumber
Statetext
Ownerobject
Owner IDtext
Typetext
Get CSV Import StatusAction
Input fields[3]
FieldType
Import IDRequired
choice
Output fields[3]
FieldType
Total linesnumber
Completed linesnumber
Statustext
Changesobject
Creatednumber
Updatednumber
Deactivatednumber
Reactivatednumber
Deletednumber
Has errorsboolean
List Collection FilesSearch
Input fields[3]
FieldType
Collection IDRequired
choice
Sort Bychoice
Limitnumber
Output fields[3]
FieldType
IDtext
Createddate
Created byobject
IDtext
First nametext
Last nametext
Mime typetext
Typetext
Originalobject
Sizenumber
Heightnumber
Widthnumber
URLurl
File nametext
File extensiontext
Reference countnumber
Playback URLtext
Durationnumber
Thumbnailobject
URLtext
Widthnumber
Heightnumber
List CollectionsSearch
Input fields[3]
FieldType
Sort Bychoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Accessor idsarray
Admin idsarray
Medium countnumber
Created atdate
Updated atdate
List CommentsSearch
Input fields[3]
FieldType
Filtertext
Formatchoice
Manageboolean
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Installation IDtext
Parent IDtext
Parent typetext
Author IDtext
Publishedboolean
Texttext
Authorobject
Entity typetext
First nametext
IDtext
Last nametext
Root IDtext
Linksobject
Unpublishobject
Deleteobject
Rightsarray
Entity typetext
Updateddate
Createddate
List CSV ImportsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Created atdate
File nametext
File sizenumber
Record countnumber
Statetext
Ownerobject
Owner IDtext
Typetext
List FilesSearch
Input fields[3]
FieldType
Collection IDRequired
choice
Filtersarray
Querytext
Sort Bychoice
Limitnumber
Output fields[3]
FieldType
IDtext
Createdtext
Created byobject
IDtext
First nametext
Last nametext
Mime typetext
Typetext
Originalobject
Sizenumber
Heightnumber
Widthnumber
URLurl
File nametext
File extensiontext
Reference countnumber
Playback URLurl
Durationnumber
Thumbnailobject
URLurl
Widthnumber
Heightnumber
List Group MembersSearch
Input fields[3]
FieldType
Group IDRequired
choice
QueryRequired
text
Statuschoice
Limitnumber
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
List GroupsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
List PagesSearch
Input fields[3]
FieldType
Order Bychoice
Statuschoice
Space IDsRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Created atdate
Updated atdate
Is outdatedboolean
Contentsobject
En usobject
De deobject
Owner IDtext
Space IDtext
Readersobject
User idsarray
Adminsobject
User idsarray
Group idsarray
Token idsarray
List TagsSearch
Input fields[3]
FieldType
Tagtext
Limitnumber
Output fields[3]
FieldType
IDtext
Valuetext
List User GroupsSearch
Input fields[3]
FieldType
User IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
List UsersSearch
Input fields[3]
FieldType
Querytext
Filtertext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
List Users by TimestampSearch
Input fields[3]
FieldType
Include Deletedboolean
Limitnumber
Output fields[3]
FieldType
Activateddate
Avatarobject
Originalobject
Iconobject
Thumbobject
Configobject
Localetext
Createddate
Departmenttext
Emailsarray
External IDtext
First nametext
Group i dsarray
IDtext
Last nametext
Locationtext
Mandatory group i dsarray
Phone numbertext
Positiontext
Profiletext
Public email addresstext
Roleobject
Typetext
Statustext
Updateddate
Search GroupsSearch
Input fields[3]
FieldType
Creator IDschoice
Sortchoice
Querytext
Typechoice
Permissionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Search PagesSearch
Input fields[3]
FieldType
Include Deleteboolean
Limitnumber
Output fields[3]
FieldType
Statetext
Entityobject
IDtext
Branch IDtext
Space IDtext
Created atdate
Updated atdate
Published atdate
Contentsobject
Owner IDtext
Readersobject
Adminsobject
Search UsersSearch
Input fields[3]
FieldType
Querytext
Filtertext
Sortchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Add a FileAction
Input fields[3]
FieldType
Medium IDRequired
choice
Add Files to a CollectionAction
Input fields[3]
FieldType
Collection IDRequired
choice
EntriesRequired
choice
Output fields[3]
FieldType
Entriesarray
Create a CollectionAction
Input fields[3]
FieldType
NameRequired
text
Admin IDschoice
Accessor IDschoice
Output fields[3]
FieldType
IDtext
Nametext
Accessor idsarray
Admin idsarray
Medium countnumber
Created atdate
Updated atdate
Create a ConversationAction
Input fields[3]
FieldType
Chat IDRequired
text
Participant IDsRequired
choice
MessageRequired
text
Typetext
Output fields[3]
FieldType
IDtext
Installation IDtext
Typetext
Creator IDtext
Admin i dsarray
Message countnumber
Metaobject
Titletext
Imageobject
Statusobject
Oldest unread message IDtext
Mutedboolean
Archivedboolean
Create a GroupAction
Input fields[3]
FieldType
ConfigurationRequired
object
LocalizationRequired
object
Show in Overviewboolean
Image URLurl
Icontext
Custom Icon URLurl
Linkurl
External IDtext
Accessor IDsobject
User IDschoice
Group IDschoice
Branch Accessboolean
Admin IDsobject
User IDschoice
Group IDschoice
Inclusionsarray
Inclusion User IDschoice
Exclusionsarray
Exclusion User IDschoice
Output fields[3]
FieldType
Accessor idsobject
Branch accessboolean
IDtext
Configobject
Localizationobject
Show in overviewboolean
Typetext
Updated atdate
Creatorobject
IDtext
Typetext
Create a PageAction
Input fields[3]
FieldType
ContentsRequired
object
English (US) Contentobject
Space IDchoice
Publishedboolean
External IDtext
Reader IDschoice
Admin IDschoice
Output fields[3]
FieldType
IDtext
Owner IDtext
Contentsobject
En usobject
De deobject
Space IDtext
Branch IDtext
Created atdate
Updated atdate
Published atdate
Readersobject
User idsarray
Branch accessboolean
Adminsobject
User idsarray
Group idsarray
Token idsarray
Delete a CollectionAction
Input fields[3]
FieldType
Collection IDRequired
choice
Delete a ConversationAction
Input fields[3]
FieldType
Conversation IDRequired
text
Delete a CSV ImportAction
Input fields[3]
FieldType
Import IDRequired
choice
Delete a GroupAction
Input fields[3]
FieldType
Group IDRequired
choice
Delete a PageAction
Input fields[3]
FieldType
Page IDRequired
choice
Delete a UserAction
Input fields[3]
FieldType
User IDRequired
choice
Invite a UserAction
Input fields[3]
FieldType
RoleRequired
text
LocaleRequired
text
User Nametext
Emailemail
External IDtext
Profileobject
Property Nametext
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Log Out a UserAction
Input fields[3]
FieldType
User IDRequired
choice
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Remove Files from a CollectionAction
Input fields[3]
FieldType
Collection IDRequired
choice
EntriesRequired
choice
Send a Recovery EmailAction
Input fields[3]
FieldType
User IDRequired
choice
Stream Import Change LogsAction
Input fields[3]
FieldType
Import IDRequired
choice
Stream Import ErrorsAction
Input fields[3]
FieldType
Import IDRequired
choice
Update a CollectionAction
Input fields[3]
FieldType
Collection IDRequired
choice
NameRequired
text
Admin IDschoice
Accessor IDschoice
Output fields[3]
FieldType
IDtext
Nametext
Accessor idsarray
Admin idsarray
Medium countnumber
Created atdate
Updated atdate
Update a GroupAction
Input fields[3]
FieldType
Group IDRequired
choice
Configurationobject
Localizationobject
Show in Overviewboolean
Image URLurl
Icontext
Custom Icon URLurl
Linkurl
External IDtext
Accessor IDsobject
User IDschoice
Group IDschoice
Branch Accessboolean
Admin IDsobject
User IDschoice
Group IDschoice
Inclusionsarray
Inclusion User IDschoice
Exclusionsarray
Exclusion User IDschoice
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Update a PageAction
Input fields[3]
FieldType
Page IDRequired
choice
Contentsobject
English (US) Contentobject
Space IDchoice
Publishedboolean
External IDtext
Reader IDschoice
Admin IDschoice
Output fields[3]
FieldType
IDtext
Owner IDtext
Contentsobject
En usobject
De deobject
Space IDtext
Branch IDtext
Created atdate
Updated atdate
Published atdate
Readersobject
User idsarray
Branch accessboolean
Adminsobject
User idsarray
Group idsarray
Token idsarray
Update a UserAction
Input fields[3]
FieldType
User IDRequired
choice
EmailRequired
email
Roletext
Statuschoice
External IDtext
Profileobject
Property Nametext
User Nametext
Recovery Codeobject
Plaintext
Expirestext
Secrettext
Send Mailboolean
Output fields[3]
FieldType
IDtext
Configobject
Localetext
Created atdate
Activated atdate
External IDtext
Roletext
Emailobject
Valuetext
Sourcetext
Statustext
Secrettext
Profileobject
Property 1text
Property 2text
User nameobject
Valuetext
Sourcetext
Update CSV Import ConfigurationAction
Input fields[3]
FieldType
Import IDRequired
choice
Deltaboolean
Generate Recovery Codesboolean
Report Mail Addressemail
Report Only On Errorsboolean
Send Mails Newboolean
Send Mails Pendingboolean
Encodingchoice
Partial Tagtext
Separatorchoice
Typechoice
Mappingarray
Update CSV Import StatusAction
Input fields[3]
FieldType
Import IDRequired
choice
Statechoice
Update Group MembersAction
Input fields[3]
FieldType
Group IDRequired
choice
User IDschoice
Output fields[3]
FieldType
IDtext
Accessor idsobject
User idsarray
Group idsarray
Branch accessboolean
Admin idsobject
User idsarray
Group idsarray
Branch accessboolean
External IDtext
Configobject
Localizationobject
Show in overviewboolean
Image URLtext
Icontext
Custom icon URLtext
Linktext
Typetext
Creatorobject
IDtext
Typetext
Updated atdate
Inclusionsarray
Inclusion user idsarray
Exclusionsarray
Exclusion user idsarray
Upload a CSV FileAction
Input fields[3]
FieldType
FileRequired
text

Look for Staffbase templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Staffbase Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Staffbase.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12