AirMason

All employee endpoints are under <code>/organizations/{orgId}/employees</code> and require an access token.

{ "id": "123…", "employeeId": "R-10482", "firstName": "Sam", "lastName": "Okafor", "email": "sam.okafor@acme.com", "jobTitle": "Account Executive", "department": "Sales", "teamName": "EMEA Sales", "location": "Lisbon", "country": "PT", "managerEmployeeId": "R-10021", "hireDate": "2025-03-01", "status": "active", "terminatedDate": null, "groups": ["Sales", "Lisbon Office"], "activatedAt": "2025-03-02T09:14:00.000Z", "createdAt": "2025-03-01T08:00:00.000Z", "updatedAt": "2026-01-12T10:30:00.000Z" }

<code>status</code> is one of <code>invited</code> (created, not yet activated), <code>active</code>, or <code>terminated</code>.

<code>GET /organizations/{orgId}/employees</code>

Optional filters: <code>status</code>, <code>email</code>, <code>group</code> (group name), <code>updatedSince</code> (ISO timestamp).

<code>GET /organizations/{orgId}/employees/{employeeRef}</code>

<code>employeeRef</code> is the AirMason <code>id</code> or <code>ext:&lt;employeeId&gt;</code>.

<code>POST /organizations/{orgId}/employees</code>

{ "employeeId": "R-10482", "firstName": "Sam", "lastName": "Okafor", "email": "sam.okafor@acme.com", "jobTitle": "Account Executive", "department": "Sales", "location": "Lisbon", "country": "PT", "managerEmployeeId": "R-10021", "hireDate": "2025-03-01", "groups": ["Sales", "Lisbon Office"], "sendWelcomeEmail": true }

<code>employeeId</code> and <code>email</code> are required and must be unique within the organization (<code>409 conflict</code> otherwise). Groups named in <code>groups</code> are created if they don't exist.

Set <code>sendWelcomeEmail: false</code> if you deliver the activation link yourself via the <code>employee.created</code> webhook.

<code>PATCH /organizations/{orgId}/employees/{employeeRef}</code>

Any field from the create request except <code>employeeId</code>.

Passing <code>groups</code> replaces the employee's full group membership; omit it to leave groups unchanged.

<code>POST /organizations/{orgId}/employees/{employeeRef}/terminate</code>

<code>terminatedDate</code> defaults to today. Terminated employees lose portal access immediately, stop receiving reminders, are excluded from <code>employeeCount</code> and signature-completion percentages, and are preserved (with their signature history) for audit purposes. To bring someone back, <code>POST …/{employeeRef}/reactivate</code>.

<code>PUT /organizations/{orgId}/employees/import</code> — <code>multipart/form-data</code> with a <code>file</code> field (CSV, up to 100 MB)

Creates or updates employees in bulk, matching on <code>employeeId</code>. Large files are processed asynchronously; the response includes a <code>jobId</code> you can poll at

<code>GET /organizations/{orgId}/employees/import/{jobId}</code>.

___________________________________________________________

Groups are how you assign handbooks to sets of employees. All under <code>/organizations/{orgId}/groups</code>, access token.

<a href="https://support.airmason.com/en/articles/16972589-partner-api-overview-and-getting-started">Overview &amp; Getting Started</a>

<a href="https://support.airmason.com/en/articles/16972590-partner-api-organizations">Organizations</a>

<a href="https://support.airmason.com/en/articles/16972592-partner-api-handbooks">Handbooks</a>

<a href="https://support.airmason.com/en/articles/16972593-partner-api-admin-sso-and-provisioning">Admin SSO &amp; Provisioning</a>

<a href="https://support.airmason.com/en/articles/16972594-partner-api-webhooks">Webhooks</a>

<a href="https://support.airmason.com/en/articles/16972595-partner-api-reference-errors-rate-limits-regions">Reference (Errors, Rate Limits, Regions)</a>

- <a href="https://support.airmason.com/en/articles/16972589-partner-api-overview-and-getting-started">Overview &amp; Getting Started</a>
- <a href="https://support.airmason.com/en/articles/16972590-partner-api-organizations">Organizations</a>
- Employees &amp; Groups
- <a href="https://support.airmason.com/en/articles/16972592-partner-api-handbooks">Handbooks</a>
- <a href="https://support.airmason.com/en/articles/16972593-partner-api-admin-sso-and-provisioning">Admin SSO &amp; Provisioning</a>
- <a href="https://support.airmason.com/en/articles/16972594-partner-api-webhooks">Webhooks</a>
- <a href="https://support.airmason.com/en/articles/16972595-partner-api-reference-errors-rate-limits-regions">Reference (Errors, Rate Limits, Regions)</a>

Create, update, terminate and bulk-import employees, and manage the groups used to assign handbooks.

Partner API: Employees & Groups

Create a custom design with text, images, and links

No tickets or conversations found

Try selecting a different creation date range.

Tickets and conversations you've started through the messenger will appear here.

No tickets or conversations created by you

Try using different keywords or checking for typos.

Try selecting a different update date range.

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

No conversations found

AI title

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

No tickets created by you

No tickets found

Conversations and tickets in {topic}

Conversations and tickets in {topic} // {subtopic}

Volume, creators and topics for your company.

Insights

Top creators

AI topics

Track the progress of all tickets and conversations related to your company.

Customer Portal.

Track the progress of all tickets related to your company.

Tickets portal.

{assigneeName} needs more information from you

Tickets

No access to tickets portal

Search

Skip the search. Describe what you’re trying to do and get a grounded answer.

Browse articles and guides in this topic.

Create your workspace and invite the people you work with.

Set up your account

Build your first workflow and watch it run end to end.

Ship something

Connect the tools your team already uses to bring data in.

Connect your stack

A quick lap of the product so you know where everything lives.

{appName} in 60 seconds

This prototype demo is aware that you are reading “{title}”. It can point you back to the current article, but a production article-aware Fin contract is still follow-up work.

Prototype article-aware answer

Because you already asked about invitations, this prototype demo can add the follow-up: use the role selector before sending each invite to limit access to the teammate responsibilities.

Prototype role-limiting follow-up

This prototype demo suggests starting with your workspace profile, inviting the team members who need access, and then connecting the integrations you use.

Prototype getting-started answer

In this prototype demo, integrations are configured from workspace settings. Choose the integration, connect the account, and review the enabled permissions.

Prototype integrations answer

In this prototype demo, invite teammates from workspace settings, then choose the access each teammate needs before sending the invitation.

Prototype invite-team answer

This prototype demo does not have a scripted answer for that question yet. Try asking how to invite your team or open a source article. No production Fin API was called.

Prototype answer unavailable

I’ve got this page open. Ask me anything about it and I’ll answer from the docs.

Method & path	Description
`GET /groups`	List groups with `employeeCount`
`POST /groups`	Create body `{ "name": "Lisbon Office" }`
`PATCH /groups/{groupId}`	Rename body `{ "name": "Lisbon Office" }`
`DELETE /groups/{groupId}`	Delete (employees are not affected)

Partner API: Employees & Groups

Employees

The employee resource

List employees

Get an employee

Create an employee

Update an employee

Terminate an employee

Bulk import

Groups