Connecteam

connecteam is a workforce management platform that simplifies team operations and enhances employee engagement connecteam is a comprehensive workforce management platform designed to streamline operations, enhance communication, and improve employee engagement the integration with swimlane turbine allows users to automate the retrieval and management of shifts, schedulers, and user data from connecteam this seamless integration empowers security teams to efficiently manage workforce schedules and user information, enhancing operational efficiency and reducing manual workload limitations none to date supported versions this connecteam connector uses the connecteam rest api ( https //api connecteam com ) an australia region base url ( https //api au connecteam com ) is also available configuration prerequisites before you can use the connecteam connector for turbine, you'll need access to the connecteam api this requires the following an api key authentication using the following parameters url the endpoint url for accessing connecteam's api services api key a unique key provided by connecteam to authenticate api requests authentication methods api key authentication url the endpoint url for the connecteam api api key your connecteam api key with sufficient permissions include this value in the x api key request header verify ssl certificates optionally verify ssl certificates for https requests http(s) proxy optionally route requests through an http(s) proxy capabilities this connecteam connector provides the following capabilities get users get schedulers get a single shift get multiple shifts get multiple shifts get users retrieves a list of all users associated with your connecteam account you can filter results by user ids, status, names, phone numbers, email addresses, creation date, and modification date connecteam's documentation for this action can be found here https //developer connecteam com/docs/read users data get schedulers retrieves a list of all schedulers (schedules) in your connecteam account connecteam's documentation for this action can be found here https //developer connecteam com/docs/scheduler get schedulers get a single shift retrieves a specific shift from a scheduler by scheduler id and shift id connecteam's documentation for this action can be found here https //developer connecteam com/docs/scheduler get shifts get multiple shifts retrieves shifts from a scheduler with flexible filtering and pagination options required parameters include starttime and endtime as unix timestamps in seconds optional filters include open shift status, published status, job ids, assigned user ids, shift ids, and title connecteam's documentation for this action can be found here https //developer connecteam com/docs/scheduler get shifts additional documentation connecteam connector documentation https //docs swimlane com/connectors/connecteamconnecteam authentication guide https //docs swimlane com/authentication guides/connecteamconnecteam authentication (vendor) https //developer connecteam com/docs/authentication 1connecteam api introduction (vendor) https //developer connecteam com/docsconnecteam rest api documentation (vendor) https //developer connecteam com/reference configurations connecteam api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required x api key api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get a single shift retrieve a specific shift from connecteam using the scheduler id and shift id endpoint url /scheduler/v1/schedulers/{{schedulerid}}/shifts/{{shiftid}} method get input argument name type required description path parameters schedulerid number required the id of the scheduler to retrieve the shift from path parameters shiftid string required the id of the shift to retrieve input example {"path parameters" {"schedulerid" 93429999,"shiftid" "1221"}} output parameter type description status code number http status code of the response reason string response reason phrase requestid string unique identifier data object response data data id string response data data title string response data data color string response data data assigneduserids array response data data starttime number response data data endtime number response data data timezone string response data data isopenshift boolean response data data ispublished boolean response data data isrequireadminapproval object response data data jobid string response data data locationdata object response data data locationdata isreferencedtojob boolean response data data locationdata gps object response data data locationdata gps address string response data data locationdata gps latitude number response data data locationdata gps longitude number response data data createdby number response data data creationtime number response data data updatetime number response data data openspots object response data output example {"status code" 200,"reason" "ok","json body" {"requestid" "a1b2c3d4 e5f6 7890 abcd ef1234567890","data" {"id" "6784dacb3c07733b0a849f49","title" "morning shift","color" "#4b7ac5","assigneduserids" \[],"starttime" 1736924400,"endtime" 1736953200,"timezone" "america/new york","isopenshift"\ false,"ispublished"\ true,"isrequireadminapproval"\ null,"jobid" "d4ad7232 576f 2ff6 c57d 8240f1089b00","locationdata" {},"createdby" 9170357,"creationtime" 1736760011,"updatetime" 1736760011}}} get multiple shifts retrieve multiple shifts from a scheduler in connecteam using flexible filtering and pagination requires schedulerid, starttime, and endtime for precise results endpoint url /scheduler/v1/schedulers/{{schedulerid}}/shifts method get input argument name type required description parameters starttime number required start of date range (unix timestamp in seconds) parameters endtime number required end of date range (unix timestamp in seconds) parameters isopenshift boolean optional filter by open shift status parameters ispublished boolean optional filter by published status parameters isrequireadminapproval boolean optional filter shifts requiring approval parameters jobid array optional parameters for the get multiple shifts action parameters assigneduserids array optional filter by job ids parameters shiftid array optional filter by specific shift ids parameters title string optional filter by shift title parameters sort string optional sort by created at or updated at parameters order string optional sort order parameters limit number optional results per page (1 500) parameters offset number optional pagination offset path parameters schedulerid number required parameters for the get multiple shifts action input example {"parameters" {"starttime" 1609459200,"endtime" 1640995200,"isopenshift"\ false,"ispublished"\ true,"isrequireadminapproval"\ false,"jobid" \[1,2,3],"assigneduserids" \[12,33,44],"shiftid" \[1001,1002],"title" "morning","sort" "created at","order" "asc","limit" 10,"offset" 0},"path parameters" {"schedulerid" 93429999}} output parameter type description status code number http status code of the response reason string response reason phrase requestid string unique identifier data object response data data shifts array response data data shifts id string response data data shifts title string response data data shifts color string response data data shifts assigneduserids array response data data shifts starttime number response data data shifts endtime number response data data shifts timezone string response data data shifts isopenshift boolean response data data shifts ispublished boolean response data data shifts isrequireadminapproval object response data data shifts jobid string response data data shifts locationdata object response data data shifts locationdata isreferencedtojob boolean response data data shifts locationdata gps object response data data shifts locationdata gps address string response data data shifts locationdata gps latitude number response data data shifts locationdata gps longitude number response data data shifts createdby number response data data shifts creationtime number response data data shifts updatetime number response data output example {"status code" 200,"reason" "ok","json body" {"requestid" "a1b2c3d4 e5f6 7890 abcd ef1234567890","data" {"shifts" \[]},"paging" {"offset" 1}}} get schedulers retrieve a list of all schedulers in your connecteam account endpoint url /scheduler/v1/schedulers method get output parameter type description status code number http status code of the response reason string response reason phrase requestid string unique identifier data object response data data schedulers array response data data schedulers schedulerid number response data data schedulers name string response data data schedulers isarchived boolean response data data schedulers timezone string response data output example {"status code" 200,"reason" "ok","json body" {"requestid" "a1b2c3d4 e5f6 7890 abcd ef1234567890","data" {"schedulers" \[]}}} get users retrieve a list of all users associated with your connecteam account endpoint url /users/v1/users method get input argument name type required description parameters limit number optional defines the maximum number of results to display per page parameters offset number optional indicates the resource offset of the last successfully read resource, allowing for pagination parameters sort string optional specifies the sorting criteria for the results parameters order string optional determines the order of the results parameters userids array optional a list of user ids to filter the results parameters userstatus string optional filters users based on their status parameters fullnames array optional enables filtering by user names parameters phonenumbers array optional filters the results by phone numbers in the expected format parameters emailaddresses array optional filters users based on provided email addresses using standard email format parameters createdat number optional filters users created after a specified date in unix format parameters modifiedat number optional filters users whose fields were updated after a specified date in unix format input example {"parameters" {"limit" 100,"offset" 0,"sort" "created at","order" "desc","userids" \[12,33,44],"userstatus" "active","fullnames" \["john doe","jane doe","jim doe"],"phonenumbers" \["1234567890","1234567891","1234567892"],"emailaddresses" \["john doe\@example com","jane doe\@example com","jim doe\@example com"],"createdat" 1609459200,"modifiedat" 1609459200}} output parameter type description status code number http status code of the response reason string response reason phrase requestid string unique identifier data object response data data users array response data data users firstname string response data data users lastname string response data data users phonenumber string response data data users usertype string response data data users email string response data data users customfields array response data data users customfields customfieldid number response data data users customfields value array response data data users customfields value id number response data data users customfields value value string response data data users customfields type string response data data users customfields name string response data data users isarchived boolean response data data users userid number response data data users createdat number response data data users modifiedat number response data data users lastlogin number response data data users smartgroupsids array response data paging object output field paging paging offset number output field paging offset output example {"status code" 200,"reason" "ok","json body" {"requestid" "e40bff49 5e00 4549 a2d2 e339026drtc3","data" {"users" \[]},"paging" {"offset" 0}}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt