> For the complete documentation index, see [llms.txt](https://help.security.gallagher.com/knowledge-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.security.gallagher.com/knowledge-hub/configuration-client/licensable-features/rest-api/cardholders.md).

# Cardholders

Using the Cardholders REST API feature, you can:

* manage Cardholders (view, create, modify, and delete Cardholders), allowing synchronisation of employee data between Command Centre and third-party systems
* manage Access Groups membership and Relationships
* manage Cardholder Competencies, Personal Data, and Lockers (assign and view allocated Lockers)
* be informed of up-to-date Cardholder changes on demand
* retrieve Access Group properties (Access Zones/Schedules, Salto Access Zones/Schedules, Alarm Zones, and Privileges)
* manage Visits (view, create, and modify) and view parts of Divisions' Visitor Management configurations. Also requires the licence string `VisitorManagement=1`

Practical uses for this REST API feature include:

* synchronising employee data between the HR system and Command Centre
* sending Cardholder data to a meeting room hire app when a credential is presented at the meeting room door
* synchronising authorised Cardholders with a key safe system
* synchronising Command Centre with an incident management application
* updating Command Centre employee location data with a third-party system.

You need the following licence string to use the Cardholders REST API feature:

`RESTCardholders=1`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.security.gallagher.com/knowledge-hub/configuration-client/licensable-features/rest-api/cardholders.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
