---
title: StaffCircle API | Help Center
description: StaffCircle API
---

[Skip to content](https://knowledge.staffcircle.info/staffcircle-api#main-content)

English

Show submenu for translations

![staffCircle_logo_trans3-1.png\]](https://knowledge.staffcircle.info/hs-fs/hubfs/staffCircle_logo_trans3-1.png?height=50&name=staffCircle_logo_trans3-1.png)

- [StaffCircle University](https://www.staffcircle.com/university)
- [StaffCircle Resources](https://www.staffcircle.com/resources/)

Open main navigation

Close main navigation

- [StaffCircle University](https://www.staffcircle.com/university)
- [StaffCircle Resources](https://www.staffcircle.com/resources/)
- English
  
  Show submenu for translations
- [Learn more at the StaffCircle University](https://www.staffcircle.com/university)

[Learn more at the StaffCircle University](https://www.staffcircle.com/university)

 Need a hand? Our FAQs are here to help!

- There are no suggestions because the search field is empty.

1. [Help Center](https://knowledge.staffcircle.info/)
2. [StaffCircle API](https://knowledge.staffcircle.info/staffcircle-api)

# StaffCircle API

- [1.0 What Are StaffCircle Webhooks?](https://knowledge.staffcircle.info/1.0-what-are-staffcircle-webhooks)
- [5.0 Data JSON Schema](https://knowledge.staffcircle.info/5.0-data-json-schema)
- [7.1.1 Flow Example - AI Sentiment Analysis](https://knowledge.staffcircle.info/7.1.1-flow-example-ai-sentiment-analysis)
- [5.8 Reviews](https://knowledge.staffcircle.info/5.8-reviews)
- [5.7 Persons](https://knowledge.staffcircle.info/5.7-persons)
- [5.9 Surveys](https://knowledge.staffcircle.info/5.9-surveys)
- [5.4 Comments](https://knowledge.staffcircle.info/5.4-comments)
- [5.5 Feedback](https://knowledge.staffcircle.info/5.5-feedback)
- [5.10 Tasks](https://knowledge.staffcircle.info/5.10-tasks)
- [5.12 Custom Data](https://knowledge.staffcircle.info/5.12-custom-data)
- [5.13 Licenses](https://knowledge.staffcircle.info/5.13-licenses)
- [5.14 Benefits](https://knowledge.staffcircle.info/5.14-benefits)
- [7.0 Integration Examples](https://knowledge.staffcircle.info/7.0-integration-examples)
- [7.1 Using Web-hooks with Power Automate (Microsoft Flow)](https://knowledge.staffcircle.info/7.1-using-web-hooks-with-power-automate-microsoft-flow)
- [6.3 DateTime ISO 8601](https://knowledge.staffcircle.info/6.3-datetime-iso-8601)
- [6.2 Notification Settings](https://knowledge.staffcircle.info/6.2-notification-settings)
- [6.1 Content Settings](https://knowledge.staffcircle.info/6.1-content-settings)
- [6.0 Shared Data Patterns](https://knowledge.staffcircle.info/6.0-shared-data-patterns)
- [5.15 Assets](https://knowledge.staffcircle.info/5.15-assets)
- [5.1 Absences](https://knowledge.staffcircle.info/5.1-absences)
- [Getting Started with our REST API](https://knowledge.staffcircle.info/getting-started-with-our-rest-api)
- [REST API URLs](https://knowledge.staffcircle.info/rest-api-urls)
- [3.2 HMAC Authentication](https://knowledge.staffcircle.info/3.2-hmac-authentication)

See less ▼

## Webhooks

- [1.0 What Are StaffCircle Webhooks?](https://knowledge.staffcircle.info/1.0-what-are-staffcircle-webhooks-1)
- [2.0 Registering A Webhook](https://knowledge.staffcircle.info/2.0-registering-a-webhook-1)
- [4.0 Webhook Format](https://knowledge.staffcircle.info/4.0-webhook-format-1)
- [5.0 Data JSON Schema](https://knowledge.staffcircle.info/5.0-data-json-schema-1)
- [5.1 Absences](https://knowledge.staffcircle.info/5.1-absences-1)
- [5.2 Articles](https://knowledge.staffcircle.info/5.2-articles-1)
- [5.3 Awards](https://knowledge.staffcircle.info/5.3-awards-1)
- [5.4 Comments](https://knowledge.staffcircle.info/5.4-comments-1)
- [5.5 Feedback](https://knowledge.staffcircle.info/5.5-feedback-1)
- [5.6 Objectives](https://knowledge.staffcircle.info/5.6-objectives-1)
- [5.6.1 Objective Progress](https://knowledge.staffcircle.info/5.6.1-objective-progress-1)
- [5.7 Persons](https://knowledge.staffcircle.info/5.7-persons-1)
- [5.8 Reviews](https://knowledge.staffcircle.info/5.8-reviews-1)
- [5.9 Surveys](https://knowledge.staffcircle.info/5.9-surveys-1)
- [5.10 Tasks](https://knowledge.staffcircle.info/5.10-tasks-1)
- [5.11 Survey Answers](https://knowledge.staffcircle.info/5.11-survey-answers-1)
- [5.12 Custom Data](https://knowledge.staffcircle.info/5.12-custom-data-1)
- [5.13 Licenses](https://knowledge.staffcircle.info/5.13-licenses-1)
- [5.14 Benefits](https://knowledge.staffcircle.info/5.14-benefits-1)
- [5.15 Assets](https://knowledge.staffcircle.info/5.15-assets-1)
- [6.0 Shared Data Patterns](https://knowledge.staffcircle.info/6.0-shared-data-patterns-1)
- [6.1 Content Settings](https://knowledge.staffcircle.info/6.1-content-settings-1)
- [6.2 Notification Settings](https://knowledge.staffcircle.info/6.2-notification-settings-1)
- [6.3 DateTime ISO 8601](https://knowledge.staffcircle.info/6.3-datetime-iso-8602)
- [7.0 Integration Examples](https://knowledge.staffcircle.info/7.0-integration-examples-1)
- [7.1 Using Web-hooks with Power Automate (Microsoft Flow)](https://knowledge.staffcircle.info/7.1-using-web-hooks-with-power-automate-microsoft-flow-1)
- [7.1.1 Flow Example - AI Sentiment Analysis](https://knowledge.staffcircle.info/7.1.1-flow-example-ai-sentiment-analysis-1)
- [7.2 Zapier](https://knowledge.staffcircle.info/7.2-zapier-1)
- [8.0 Json Schemas](https://knowledge.staffcircle.info/8.0-json-schemas)
- [The Big Picture - Tips To Create A Great Communication Strategy To Engage Your Workforce](https://knowledge.staffcircle.info/the-big-picture-tips-to-create-a-great-communication-strategy-to-engage-your-workforce-1)
- [4.0 Webhook Format](https://knowledge.staffcircle.info/4.0-webhook-format)
- [2.0 Registering A Webhook](https://knowledge.staffcircle.info/2.0-registering-a-webhook)

See less ▼

## REST APIs

- [How to Deactivate and Remove Leavers via the API](https://knowledge.staffcircle.info/how-to-deactivate-and-remove-leavers-via-the-api)
- [Getting Started with our REST API](https://knowledge.staffcircle.info/getting-started-with-our-rest-api-1)
- [REST API URLs](https://knowledge.staffcircle.info/rest-api-urls-1)
- [5.3 Awards](https://knowledge.staffcircle.info/5.3-awards)
- [3.1 API Key](https://knowledge.staffcircle.info/3.1-api-key)

## API Security

- [3.0 Security](https://knowledge.staffcircle.info/3.0-security-1)
- [3.1 API Key](https://knowledge.staffcircle.info/3.1-api-key-1)
- [3.2 HMAC Authentication](https://knowledge.staffcircle.info/3.2-hmac-authentication-1)
- [3.0 Security](https://knowledge.staffcircle.info/3.0-security)

## Surveys

- [5.11 Survey Answers](https://knowledge.staffcircle.info/5.11-survey-answers)

## Articles

- [5.2 Articles](https://knowledge.staffcircle.info/5.2-articles)

- [Product Releases](https://knowledge.staffcircle.info/product-releases#main-content)
  
  
  
  
  
    - [New Features](https://knowledge.staffcircle.info/product-releases#new-features)
    - [Minor Releases](https://knowledge.staffcircle.info/product-releases#minor-releases)
- [Comms](https://knowledge.staffcircle.info/comms#main-content)
  
  
  
  
  
    - [Feeds & Channels](https://knowledge.staffcircle.info/comms#feeds-channels)
    - [Managing Content](https://knowledge.staffcircle.info/comms#managing-content)
    - [Content Types](https://knowledge.staffcircle.info/comms#content-types)
    - [Surveys](https://knowledge.staffcircle.info/comms#surveys)
    - [Survey Templates](https://knowledge.staffcircle.info/comms#survey-templates)
    - [Awards & Feedback](https://knowledge.staffcircle.info/comms#awards-feedback)
    - [Notifications & Alerts](https://knowledge.staffcircle.info/comms#notifications-alerts)
    - [Dashboards](https://knowledge.staffcircle.info/comms#dashboards)
    - [Reports](https://knowledge.staffcircle.info/comms#reports)
    - [FAQ's](https://knowledge.staffcircle.info/comms#faqs)
- [Integrations](https://knowledge.staffcircle.info/integrations#main-content)
  
  
  
  
  
    - [Office 365 Integration](https://knowledge.staffcircle.info/integrations#office-365-integration)
    - [Microsoft Teams](https://knowledge.staffcircle.info/integrations#microsoft-teams)
    - [One Login Integration](https://knowledge.staffcircle.info/integrations#one-login-integration)
    - [Microsoft Power Automate Integration](https://knowledge.staffcircle.info/integrations#microsoft-power-automate-integration)
    - [Microsoft Partners](https://knowledge.staffcircle.info/integrations#microsoft-partners)
    - [Microsoft Power BI](https://knowledge.staffcircle.info/integrations#microsoft-power-bi)
    - [HRIS connectors](https://knowledge.staffcircle.info/integrations#hris-connectors)
    - [IRIS Cascade Connector](https://knowledge.staffcircle.info/integrations#iris-cascade-connector)
    - [StaffCircle MCPx (model context protocol)](https://knowledge.staffcircle.info/integrations#staffcircle-mcpx-model-context-protocol)
    - [LMS Connectors](https://knowledge.staffcircle.info/integrations#lms-connectors)
    - [Zapier](https://knowledge.staffcircle.info/integrations#zapier)
    - [Workable](https://knowledge.staffcircle.info/integrations#workable)
    - [Connectors](https://knowledge.staffcircle.info/integrations#connectors)
    - [E-Sign (Signable)](https://knowledge.staffcircle.info/integrations#e-sign-signable)
    - [Feedly](https://knowledge.staffcircle.info/integrations#feedly)
- [Objectives](https://knowledge.staffcircle.info/objectives#main-content)
  
  
  
  
  
    - [Templates](https://knowledge.staffcircle.info/objectives#templates)
    - [Competencies](https://knowledge.staffcircle.info/objectives#competencies)
    - [Priorities](https://knowledge.staffcircle.info/objectives#priorities)
    - [Reports](https://knowledge.staffcircle.info/objectives#reports)
    - [Leaderboard/Dashboard](https://knowledge.staffcircle.info/objectives#leaderboard-dashboard)
    - [FAQ's](https://knowledge.staffcircle.info/objectives#faqs)
    - [Cascading & Linked Objectives](https://knowledge.staffcircle.info/objectives#cascading-linked-objectives)
    - [Bulk Amendments & Deletions](https://knowledge.staffcircle.info/objectives#bulk-amendments-deletions)
- [Reviews](https://knowledge.staffcircle.info/reviews#main-content)
  
  
  
  
  
    - [Templates](https://knowledge.staffcircle.info/reviews#templates)
    - [Template Configuration](https://knowledge.staffcircle.info/reviews#template-configuration)
    - [Feedback Questions](https://knowledge.staffcircle.info/reviews#feedback-questions)
    - [Reports](https://knowledge.staffcircle.info/reviews#reports)
    - [Other Settings](https://knowledge.staffcircle.info/reviews#other-settings)
    - [9 Box Grid](https://knowledge.staffcircle.info/reviews#9-box-grid)
    - [FAQ's](https://knowledge.staffcircle.info/reviews#faqs)
- [People & Groups](https://knowledge.staffcircle.info/people-groups#main-content)
  
  
  
  
  
    - [People](https://knowledge.staffcircle.info/people-groups#people)
    - [Groups](https://knowledge.staffcircle.info/people-groups#groups)
    - [Roles](https://knowledge.staffcircle.info/people-groups#roles)
    - [Custom Fields](https://knowledge.staffcircle.info/people-groups#custom-fields)
    - [Reports & Dashboards](https://knowledge.staffcircle.info/people-groups#reports-dashboards)
    - [Detail Sections](https://knowledge.staffcircle.info/people-groups#detail-sections)
    - [Import & Export](https://knowledge.staffcircle.info/people-groups#import-export)
    - [Onboarding](https://knowledge.staffcircle.info/people-groups#onboarding)
    - [FAQ's](https://knowledge.staffcircle.info/people-groups#faqs)
- [Employee Development](https://knowledge.staffcircle.info/employee-development#main-content)
  
  
  
  
  
    - [Course Library](https://knowledge.staffcircle.info/employee-development#course-library)
    - [Development Objectives](https://knowledge.staffcircle.info/employee-development#development-objectives)
    - [Career Development Reviews](https://knowledge.staffcircle.info/employee-development#career-development-reviews)
    - [Succession Planning](https://knowledge.staffcircle.info/employee-development#succession-planning)
    - [FAQ's](https://knowledge.staffcircle.info/employee-development#faqs)
    - [Skills](https://knowledge.staffcircle.info/employee-development#skills)
- [Holiday & Absence](https://knowledge.staffcircle.info/holiday-absence#main-content)
  
  
  
  
  
    - [Absence Policies](https://knowledge.staffcircle.info/holiday-absence#absence-policies)
    - [Working Patterns](https://knowledge.staffcircle.info/holiday-absence#working-patterns)
    - [Company Holidays](https://knowledge.staffcircle.info/holiday-absence#company-holidays)
    - [Absence Types](https://knowledge.staffcircle.info/holiday-absence#absence-types)
    - [Year End Reset](https://knowledge.staffcircle.info/holiday-absence#year-end-reset)
    - [Settings](https://knowledge.staffcircle.info/holiday-absence#settings)
    - [Reports](https://knowledge.staffcircle.info/holiday-absence#reports)
    - [ARCHIVED CONTENT](https://knowledge.staffcircle.info/holiday-absence#archived-content)
    - [FAQ's](https://knowledge.staffcircle.info/holiday-absence#faqs)
- [General Questions](https://knowledge.staffcircle.info/general-questions#main-content)
  
  
  
  
  
    - [Applications](https://knowledge.staffcircle.info/general-questions#applications)
- [Custom Insights Module](https://knowledge.staffcircle.info/custom-insights-module#main-content)
  
  
  
  
  
    - [Microsoft PowerBI](https://knowledge.staffcircle.info/custom-insights-module#microsoft-powerbi)
- [Skills](https://knowledge.staffcircle.info/skills#main-content)
  
  
  
  
  
    - [Overview](https://knowledge.staffcircle.info/skills#overview)
    - [Configuration](https://knowledge.staffcircle.info/skills#configuration)
    - [Dashboards](https://knowledge.staffcircle.info/skills#dashboards)
    - [Importers](https://knowledge.staffcircle.info/skills#importers)
    - [HELPER TOOL ARTICLES](https://knowledge.staffcircle.info/skills#helper-tool-articles)
- [Organisation & Branding](https://knowledge.staffcircle.info/organisation-branding#main-content)
  
  
  
  
  
    - [Information](https://knowledge.staffcircle.info/organisation-branding#information)
    - [Values](https://knowledge.staffcircle.info/organisation-branding#values)
    - [Departments](https://knowledge.staffcircle.info/organisation-branding#departments)
    - [Sites](https://knowledge.staffcircle.info/organisation-branding#sites)
    - [Regions](https://knowledge.staffcircle.info/organisation-branding#regions)
    - [Branding](https://knowledge.staffcircle.info/organisation-branding#branding)
    - [Customisation](https://knowledge.staffcircle.info/organisation-branding#customisation)
    - [BETA Features](https://knowledge.staffcircle.info/organisation-branding#beta-features)
- [Tasks & Worksheets](https://knowledge.staffcircle.info/tasks-worksheets#main-content)
  
  
  
  
  
    - [tasks & Worksheets](https://knowledge.staffcircle.info/tasks-worksheets#tasks-worksheets)
- [E-Sign (Signable)](https://knowledge.staffcircle.info/e-sign-signable#main-content)
  
  
  
  
  
    - [E-Sign Set Up](https://knowledge.staffcircle.info/e-sign-signable#e-sign-set-up)
    - [E-sign tags](https://knowledge.staffcircle.info/e-sign-signable#e-sign-tags)
    - [E-sign reporting](https://knowledge.staffcircle.info/e-sign-signable#e-sign-reporting)
- [Other Modules](https://knowledge.staffcircle.info/other-modules#main-content)
  
  
  
  
  
    - [Documents](https://knowledge.staffcircle.info/other-modules#documents)
    - [New Menu & Search Bar](https://knowledge.staffcircle.info/other-modules#new-menu-search-bar)
    - [Security Permissions](https://knowledge.staffcircle.info/other-modules#security-permissions)
    - [FAQ](https://knowledge.staffcircle.info/other-modules#faq)
- [FAQ's](https://knowledge.staffcircle.info/faqs#main-content)
  
  
  
  
  
    - [People](https://knowledge.staffcircle.info/faqs#people)
    - [Other](https://knowledge.staffcircle.info/faqs#other)
    - [Product Specification](https://knowledge.staffcircle.info/faqs#product-specification)
- [Guidance](https://knowledge.staffcircle.info/guidance)
- [Awards & Feedback](https://knowledge.staffcircle.info/awards-feedback)
- [Google Integration](https://knowledge.staffcircle.info/google-integration)
- [Product Specification](https://knowledge.staffcircle.info/product-specification#main-content)
  
  
  
  
  
    - [Comms and Culture](https://knowledge.staffcircle.info/product-specification#comms-and-culture)
    - [Performance Management](https://knowledge.staffcircle.info/product-specification#performance-management)
    - [HR Operations](https://knowledge.staffcircle.info/product-specification#hr-operations)
    - [Common Features](https://knowledge.staffcircle.info/product-specification#common-features)
    - [Core Functionality](https://knowledge.staffcircle.info/product-specification#core-functionality)
- [Templates](https://knowledge.staffcircle.info/templates#main-content)
  
  
  
  
  
    - [Review Question Templates](https://knowledge.staffcircle.info/templates#review-question-templates)
    - [Objective Templates](https://knowledge.staffcircle.info/templates#objective-templates)
    - [Survey Templates](https://knowledge.staffcircle.info/templates#survey-templates)
    - [Skill Set Templates](https://knowledge.staffcircle.info/templates#skill-set-templates)
    - [E-Sign Templates](https://knowledge.staffcircle.info/templates#e-sign-templates)
- [StaffCircle API](https://knowledge.staffcircle.info/staffcircle-api#main-content)
  
  
  
  
  
    - [Webhooks](https://knowledge.staffcircle.info/staffcircle-api#webhooks)
    - [REST APIs](https://knowledge.staffcircle.info/staffcircle-api#rest-apis)
    - [API Security](https://knowledge.staffcircle.info/staffcircle-api#api-security)
    - [Surveys](https://knowledge.staffcircle.info/staffcircle-api#surveys)
    - [Articles](https://knowledge.staffcircle.info/staffcircle-api#articles)
- [Service Policy Documents](https://knowledge.staffcircle.info/service-policy-documents)
- [HR Operations Module](https://knowledge.staffcircle.info/hr-operations-module#main-content)
  
  
  
  
  
    - [People and Groups](https://knowledge.staffcircle.info/hr-operations-module#people-and-groups)
- [Employee Engagement Module](https://knowledge.staffcircle.info/employee-engagement-module#main-content)
  
  
  
  
  
    - [Realtime Feedback](https://knowledge.staffcircle.info/employee-engagement-module#realtime-feedback)
    - [Surveys](https://knowledge.staffcircle.info/employee-engagement-module#surveys)
- [Troubleshooting](https://knowledge.staffcircle.info/troubleshooting#main-content)
  
  
  
  
  
    - [Access & Permissions](https://knowledge.staffcircle.info/troubleshooting#access-permissions)
    - [Passwords and Password Reset](https://knowledge.staffcircle.info/troubleshooting#passwords-and-password-reset)
    - [Holidays & Absence](https://knowledge.staffcircle.info/troubleshooting#holidays-absence)
- [Security & Access](https://knowledge.staffcircle.info/security-access#main-content)
  
  
  
  
  
    - [2FA](https://knowledge.staffcircle.info/security-access#2fa)

- [StaffCircle University](https://www.staffcircle.com/university)
- [StaffCircle Resources](https://www.staffcircle.com/resources/)

[![Chill listening crop-3](https://knowledge.staffcircle.info/hs-fs/hubfs/staffCircle_logo_trans_icon-3.png?width=24&height=24&name=staffCircle_logo_trans_icon-3.png "Chill listening crop-3")](http://staffcircle.com)

help.staffcircle.com

Copyright © 2026, StaffCircle Ltd