Import users, groups, qualifications and rates
This article lists the columns you can use when you import users, groups, qualifications and user rates from a CSV file, and how Kompass decides whether a row updates an existing record or adds a new one. For how the Import dialog works, see Import records from a CSV file. Developers using the API can find the same columns in the API reference.
Where to import
Open Users, choose Actions, then Import. Groups, qualifications and user rates cannot be imported in Kompass yet; developers can import them through the API.
How rows are matched
- Users: a row with an
id updates that user. Otherwise Kompass looks for a user with the same email address. A row that matches nothing adds a new user.
- Groups: a row with an
id updates that group. Otherwise Kompass looks for a group with exactly the same name. Put 1 or yes in the delete column to delete a group; a delete row needs the group's ID.
- Qualifications: Kompass looks for a qualification of the same user with the same name. Put 1 or yes in the
delete column to remove one.
- User rates: a row with an
id updates that rate; a row without one adds a new rate.
Reading the column tables
Required marks a column a new record needs. A row that updates an existing record only changes the columns in your file, so you can leave the others out. Finds the record marks a column Kompass uses to find the existing record a row updates. Column names must match exactly, including underscores. Where a column only takes certain values, the description lists them. A column marked Needs an extra permission is only accepted from users who have that permission; for anyone else the import reports it as an unknown column. The Download template button in the Import dialog gives you the header row for your own permissions.
Users
| Column |
Required |
Finds the record |
Description |
id |
No |
Yes |
Kompass ID of the record to update. When empty, the row adds a new record unless its other columns match an existing one. |
address_country |
No |
No |
Two-letter country code, such as GB or US, or the country name. |
address_line1 |
No |
No |
First line of the user's address. |
address_line2 |
No |
No |
Second line of the user's address. |
address_town |
No |
No |
Town or city of the user's address. |
address_state |
No |
No |
State or province of the user's address. |
address_postal_code |
No |
No |
Postal or ZIP code of the user's address. |
department_id |
No |
No |
Kompass ID of the user's department. Or use department_name. |
department_name |
No |
No |
Name of the user's department, as shown in Kompass. Or use department_id. |
end |
No |
No |
Last day the user is employed, such as 2026-01-31. Leave empty for no end date. |
email |
No |
Yes |
Email address of the user. Used to find an existing user; a new user needs it. |
external |
No |
No |
Put yes if the user is external, such as a subcontractor. |
first_name |
No |
No |
First name of the user. |
group_name |
No |
No |
Names of the user's permission groups, separated by commas. Or use groups. |
groups |
No |
No |
Kompass IDs of the user's permission groups, separated by commas. Or use group_name. |
last_name |
No |
No |
Last name of the user. |
manager_email |
No |
No |
Email address of the user's manager. Or use manager_id. |
manager_id |
No |
No |
Kompass ID of the user's manager. Or use manager_email. |
org_id |
No |
No |
Kompass ID of the user's main organization. Or use org_name. |
org_name |
No |
No |
Name of the user's main organization. Or use org_id. |
password |
No |
No |
Password for the user, at least 8 characters. Leave empty for a new user to create it without a usable password. |
phone_extension |
No |
No |
Office phone extension. |
phone_home |
No |
No |
Home phone number. |
phone_mobile |
No |
No |
Mobile phone number. |
phone_office |
No |
No |
Office phone number. |
position |
No |
No |
Job title or position. |
schedule_id |
No |
No |
Kompass ID of the work schedule to assign. |
schedule_start |
No |
No |
First day the work schedule applies, such as 2026-01-31. |
schedule_end |
No |
No |
Last day the work schedule applies, such as 2026-01-31. |
start |
No |
No |
First day the user is employed, such as 2026-01-31. |
title |
No |
No |
Title or suffix, such as Mr, Mrs, Dr or PhD. |
udf |
No |
No |
Custom field values. Copy the format from an export of this list. Leave the column out to keep the current values. |
udf_schema_id |
No |
No |
ID of the custom field set to use. Leave empty for the default set. |
Groups
| Column |
Required |
Finds the record |
Description |
id |
No |
Yes |
Kompass ID of the record to update. When empty, the row adds a new record unless its other columns match an existing one. |
groups_include |
No |
No |
Names of other groups whose permissions this group also grants, separated by commas. Replaces the current list; leave the column out to keep it. A group added earlier in the same file can be named. |
name |
No |
Yes |
Group name. Without an id, finds the group by name and creates it when nothing matches. With an id, renames the group. |
permissions |
No |
No |
Permissions the group grants, separated by commas, as in an export of the groups list. Replaces the group's permissions; leave the column out to keep them. |
user_emails |
No |
No |
Email addresses of the group's members, separated by commas. Together with user_ids, replaces the membership; leave both columns out to keep it. |
user_ids |
No |
No |
Kompass IDs of the group's members, separated by commas. |
delete |
No |
No |
Put 1 or yes to delete the matching record. |
Qualifications
| Column |
Required |
Finds the record |
Description |
end |
No |
No |
Last day the qualification is valid, such as 2026-01-31. Leave empty if it does not expire. |
name |
Yes |
Yes |
Name of the qualification or certificate. |
notes |
No |
No |
Notes about the qualification. |
reference |
No |
No |
Certificate or reference number. |
start |
No |
No |
Date the qualification was obtained, such as 2026-01-31. |
user_email |
No |
Yes |
Email address of the user the qualification belongs to. Or use user_id. |
user_id |
No |
Yes |
Kompass ID of the user the qualification belongs to. Or use user_email. |
delete |
No |
No |
Put 1 or yes to delete the matching record. |
User rates
| Column |
Required |
Finds the record |
Description |
id |
No |
Yes |
Kompass ID of the record to update. When empty, the row adds a new record unless its other columns match an existing one. |
billing_per_hour |
No |
No |
Billing rate per hour. Anyone who can import user rates can set it, even without permission to see billing rates. |
cost_per_hour |
No |
No |
Cost rate per hour. Anyone who can import user rates can set it, even without permission to see cost rates. |
start |
Yes |
No |
First day the rate applies, such as 2026-01-31. |
user_email |
No |
No |
Email address of the user the rate belongs to. Or use user_id. |
user_id |
No |
No |
Kompass ID of the user the rate belongs to. Or use user_email. |