> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sympa

> How to set up the Sympa connector, plus the actions that are available.

![Sympa](https://stackone-logos.com/api/sympa/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/sympa/changelog.md)

[9 actions](#actions) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/sympa/guides/connector-profile/api-key.md)
>
> Uses a plain API key, issued per API interface in the Sympa HR admin panel, sent as the X-ApiKey request header. Does no...

> [card] [Basic Authentication · Connector Profile](https://docs.stackone.com/connectors/sympa/guides/connector-profile/basic-authentication.md)
>
> Uses HTTP Basic Authentication with the API key as the username and a separate API secret as the password. Does not expi...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/sympa/guides/link-account/api-key.md)

> [card] [Basic Authentication · Link Account](https://docs.stackone.com/connectors/sympa/guides/link-account/basic-authentication.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

Basic Authentication

No auth methods found

9 actions

ActionDescription

List Records`sympa_list_records`

Query datacards from a configured Sympa API interface.

Create Record`sympa_create_record`

Create a new datacard on a configured Sympa API interface.

Update Record`sympa_update_record`

Update an existing datacard on a configured Sympa API interface.

Bulk Create Table Rows`sympa_bulk_create_table_rows`

Append table rows to one or more existing datacards in a single request.

Get Service Document`sympa_get_service_document`

List the API interfaces available to this API key.

Get Metadata Document`sympa_get_metadata_document`

Get the metadata describing every interface's fields for this API key.

Create Table Row`sympa_create_table_row`

Create a new table row on an existing datacard.

Update Table Row`sympa_update_table_row`

Update an existing table row on a datacard.

Create Table Row With Attachment`sympa_create_table_row_with_attachment`

Create a new table row with a PDF attachment on an existing datacard.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.