External API clients

The External API Clients screen is where you set up connections that let another system exchange data with Open Core HR — for example, to keep records in sync or send updates when something changes. Each connection gets its own access token. Open it from External API Clients in the left menu, under the Settings heading. This screen is for super admins only.

1. External API Clients — Open External API Clients from the menu.

What you'll see

A table of connections with these columns:

• ID
• Name
• Code — the short identifier for the connection.
• Status — Active or Inactive.
• Tokens — how many access tokens the connection has.
• Last Sync — when the other system last exchanged data, if recorded.
• Actions — a pencil button to edit, a key button to generate a token, and a trash button to remove the connection.

Use the search box above the table to filter.

Adding a connection

1. Open External API Clients from the left menu.
2. Click Add Client.
3. In the panel that slides in, fill in:
   • Name (required)
   • Code (required) — the short identifier.
   • Contact Email (optional) — who to contact about this connection.
   • Description (optional)
   • Active — whether the connection is enabled.
4. Click Create.

Generating an access token

1. On the connection's row, click the key button.
2. A dialog titled API Token Generated shows the token. Copy it now — it won't be shown again. Use the copy button, then click Done.
3. Give the token to whoever is setting up the other system.

Editing a connection

1. Click the pencil button on the connection's row.
2. Change the details in the slide-in panel.
3. Click Update.

Removing a connection

1. Click the trash button on the connection's row.
2. Confirm in the Delete Client dialog. All of the connection's tokens stop working, and this can't be undone.

Tips

• Treat the token like a password — anyone who has it can connect to Open Core HR as that connection. Copy it somewhere safe when you generate it; there's no way to see it again.
• Set a connection to Inactive to pause it without deleting it.