# Argus

> Developer documentation for the Argus API.

- [Introduction](https://docs.lmrp.uk/index.md): What the Argus API is, who it is for, and how this documentation is organised.
- [Authentication](https://docs.lmrp.uk/authentication.md): How callers prove who they are: the browser session, service credentials, and temporary Developer Access.
- [Quickstart](https://docs.lmrp.uk/quickstart.md): Make a first authenticated request and learn the conventions every endpoint shares.
- [Permissions](https://docs.lmrp.uk/permissions.md): Every permission key in Argus, what it allows, and which endpoints check it.
- [Errors](https://docs.lmrp.uk/errors.md): The error envelope, every status the API returns, and how to handle conflicts.
- [CAD and Control](https://docs.lmrp.uk/concepts/cad-and-control.md): The two sides of dispatch in Argus: Control, which runs incidents, and the MDT, which belongs to each crew.
- [Units and crew](https://docs.lmrp.uk/concepts/units-and-crew.md): How units, crew membership and unit status work, and who is allowed to change each.
- [Incident lifecycle](https://docs.lmrp.uk/concepts/incident-lifecycle.md): How a call becomes an incident, how units attend it, and what closing and reopening do.
- [Optimistic concurrency](https://docs.lmrp.uk/concepts/optimistic-concurrency.md): The version field on incidents and units, what a 409 means, and how a client should respond.
- [Civilian records and the PNC](https://docs.lmrp.uk/concepts/civilian-records.md): Why civilian data has two sets of endpoints, what each side can see, and how official history is kept.
- [API status](https://docs.lmrp.uk/api-status.md): What the Argus API covers today, what it deliberately does not promise, known rough edges, and what has changed.
- [API conventions](https://docs.lmrp.uk/api-reference/overview.md): Rules every Argus endpoint follows, and how to read the reference pages.
- [Start Discord sign-in](https://docs.lmrp.uk/api-reference/authentication/start-discord-sign-in.md): **Access:** Public. No session is needed.
- [Complete Discord sign-in](https://docs.lmrp.uk/api-reference/authentication/complete-discord-sign-in.md): **Access:** Public. No session is needed.
- [Start Roblox account linking](https://docs.lmrp.uk/api-reference/authentication/start-roblox-account-linking.md): **Permission:** None beyond being signed in.
- [Complete Roblox account linking](https://docs.lmrp.uk/api-reference/authentication/complete-roblox-account-linking.md): **Permission:** None beyond being signed in.
- [Sign out](https://docs.lmrp.uk/api-reference/authentication/sign-out.md): **Permission:** None beyond being signed in.
- [Get the current user](https://docs.lmrp.uk/api-reference/authentication/get-the-current-user.md): **Permission:** None beyond being signed in.
- [Enable Developer Access](https://docs.lmrp.uk/api-reference/authentication/enable-developer-access.md): **Permission:** None beyond being signed in.
- [Disable Developer Access](https://docs.lmrp.uk/api-reference/authentication/disable-developer-access.md): **Permission:** None beyond being signed in.
- [List incidents](https://docs.lmrp.uk/api-reference/cad-incidents/list-incidents.md): **Permission:** `cad.view`.
- [Get an incident](https://docs.lmrp.uk/api-reference/cad-incidents/get-an-incident.md): **Permission:** `cad.view`.
- [Create an incident](https://docs.lmrp.uk/api-reference/cad-incidents/create-an-incident.md): **Permission:** `cad.incidents.create`. Requires `cad.view` as well, like every Control endpoint.
- [Edit an incident](https://docs.lmrp.uk/api-reference/cad-incidents/edit-an-incident.md): **Permission:** `cad.incidents.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Close an incident](https://docs.lmrp.uk/api-reference/cad-incidents/close-an-incident.md): **Permission:** `cad.incidents.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Reopen an incident](https://docs.lmrp.uk/api-reference/cad-incidents/reopen-an-incident.md): **Permission:** `cad.incidents.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Assign a unit](https://docs.lmrp.uk/api-reference/cad-incidents/assign-a-unit.md): **Permission:** `cad.dispatch`. Requires `cad.view` as well, like every Control endpoint.
- [Release a unit](https://docs.lmrp.uk/api-reference/cad-incidents/release-a-unit.md): **Permission:** `cad.dispatch`. Requires `cad.view` as well, like every Control endpoint.
- [List units](https://docs.lmrp.uk/api-reference/cad-units/list-units.md): **Permission:** `cad.view`.
- [List users who can crew a unit](https://docs.lmrp.uk/api-reference/cad-units/list-users-who-can-crew-a-unit.md): **Permission:** `cad.units.manage`. Requires `cad.view` as well, like every Control endpoint.
- [List a unit's crew history](https://docs.lmrp.uk/api-reference/cad-units/list-a-units-crew-history.md): **Permission:** `cad.view`.
- [Create a unit](https://docs.lmrp.uk/api-reference/cad-units/create-a-unit.md): **Permission:** `cad.units.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Edit a unit](https://docs.lmrp.uk/api-reference/cad-units/edit-a-unit.md): **Permission:** `cad.units.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Set a unit's status](https://docs.lmrp.uk/api-reference/cad-units/set-a-units-status.md): **Permission:** `cad.units.manage`. Requires `cad.view` as well, like every Control endpoint.
- [List calls](https://docs.lmrp.uk/api-reference/cad-calls/list-calls.md): **Permission:** `cad.view`.
- [Record a call](https://docs.lmrp.uk/api-reference/cad-calls/record-a-call.md): **Permission:** `cad.calls.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Attach a call to an incident](https://docs.lmrp.uk/api-reference/cad-calls/attach-a-call-to-an-incident.md): **Permission:** `cad.calls.manage`. Requires `cad.view` as well, like every Control endpoint.
- [Create an incident from a call](https://docs.lmrp.uk/api-reference/cad-calls/create-an-incident-from-a-call.md): **Permission:** `cad.calls.manage` and `cad.incidents.create`. Requires `cad.view` as well, like every Control endpoint.
- [Resolve a call without an incident](https://docs.lmrp.uk/api-reference/cad-calls/resolve-a-call-without-an-incident.md): **Permission:** `cad.calls.manage`. Requires `cad.view` as well, like every Control endpoint.
- [List CAD events](https://docs.lmrp.uk/api-reference/cad-events/list-cad-events.md): **Permission:** `cad.view`.
- [Get my current unit](https://docs.lmrp.uk/api-reference/mdt/get-my-current-unit.md): **Permission:** Any signed-in user. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List units on duty](https://docs.lmrp.uk/api-reference/mdt/list-units-on-duty.md): **Permission:** `cad.unit.self`. Also needs an active staff profile. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Book on](https://docs.lmrp.uk/api-reference/mdt/book-on.md): **Permission:** `cad.unit.self`. Also needs an active staff profile. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Join a unit](https://docs.lmrp.uk/api-reference/mdt/join-a-unit.md): **Permission:** `cad.unit.self`. Also needs an active staff profile. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Change my unit's status](https://docs.lmrp.uk/api-reference/mdt/change-my-units-status.md): **Permission:** `cad.unit.self`. Also needs an active staff profile and active membership of the unit. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Book off](https://docs.lmrp.uk/api-reference/mdt/book-off.md): **Permission:** Any signed-in user who is active crew on the unit. No permission is needed, so someone who has lost their role can still leave. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List my characters](https://docs.lmrp.uk/api-reference/civilians/list-my-characters.md): **Permission:** `civilians.manage_own`.
- [Create a character](https://docs.lmrp.uk/api-reference/civilians/create-a-character.md): **Permission:** `civilians.create`.
- [Get a character](https://docs.lmrp.uk/api-reference/civilians/get-a-character.md): **Permission:** `civilians.manage_own`. The character's owner, or anyone with `civilians.manage`.
- [Update a character](https://docs.lmrp.uk/api-reference/civilians/update-a-character.md): **Permission:** `civilians.manage_own`. The character's owner, or anyone with `civilians.manage`.
- [Issue a driving licence](https://docs.lmrp.uk/api-reference/civilians/issue-a-driving-licence.md): **Permission:** `civilians.manage_own`. The character's owner, or anyone with `civilians.manage`.
- [Register a vehicle](https://docs.lmrp.uk/api-reference/civilians/register-a-vehicle.md): **Permission:** `civilians.manage_own`. The character's owner, or anyone with `civilians.manage`.
- [Update a vehicle's description](https://docs.lmrp.uk/api-reference/civilians/update-a-vehicles-description.md): **Permission:** `civilians.manage_own`. The character's owner, or anyone with `civilians.manage`. Changing `plate` always needs `civilians.manage`.
- [Transfer a vehicle to another character](https://docs.lmrp.uk/api-reference/civilians/transfer-a-vehicle-to-another-character.md): **Permission:** `civilians.manage_own`. The caller must own both characters, or hold `civilians.manage`.
- [Search people](https://docs.lmrp.uk/api-reference/pnc-lookup/search-people.md): **Permission:** `pnc.view`.
- [Get a person's record](https://docs.lmrp.uk/api-reference/pnc-lookup/get-a-persons-record.md): **Permission:** `pnc.view`.
- [Search vehicles](https://docs.lmrp.uk/api-reference/pnc-lookup/search-vehicles.md): **Permission:** `pnc.view`.
- [Get a vehicle's record](https://docs.lmrp.uk/api-reference/pnc-lookup/get-a-vehicles-record.md): **Permission:** `pnc.view`.
- [Change a vehicle's official status](https://docs.lmrp.uk/api-reference/pnc-lookup/change-a-vehicles-official-status.md): **Permission:** `pnc.vehicles.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List record history](https://docs.lmrp.uk/api-reference/pnc-lookup/list-record-history.md): **Permission:** `pnc.view`.
- [Suspend, revoke or reinstate a licence](https://docs.lmrp.uk/api-reference/pnc-licences/suspend-revoke-or-reinstate-a-licence.md): **Permission:** `pnc.licences.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Amend a licence](https://docs.lmrp.uk/api-reference/pnc-licences/amend-a-licence.md): **Permission:** `pnc.licences.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Add an endorsement](https://docs.lmrp.uk/api-reference/pnc-licences/add-an-endorsement.md): **Permission:** `pnc.licences.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Remove an endorsement](https://docs.lmrp.uk/api-reference/pnc-licences/remove-an-endorsement.md): **Permission:** `pnc.licences.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List records](https://docs.lmrp.uk/api-reference/pnc-records/list-records.md): **Permission:** `pnc.view`.
- [Create a record](https://docs.lmrp.uk/api-reference/pnc-records/create-a-record.md): **Permission:** `pnc.records.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Amend a record](https://docs.lmrp.uk/api-reference/pnc-records/amend-a-record.md): **Permission:** `pnc.records.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List warrants](https://docs.lmrp.uk/api-reference/pnc-warrants/list-warrants.md): **Permission:** `pnc.view`.
- [Issue a warrant](https://docs.lmrp.uk/api-reference/pnc-warrants/issue-a-warrant.md): **Permission:** `pnc.warrants.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Execute, cancel or amend a warrant](https://docs.lmrp.uk/api-reference/pnc-warrants/execute-cancel-or-amend-a-warrant.md): **Permission:** `pnc.warrants.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List markers](https://docs.lmrp.uk/api-reference/pnc-markers/list-markers.md): **Permission:** `pnc.view`.
- [Add a marker](https://docs.lmrp.uk/api-reference/pnc-markers/add-a-marker.md): **Permission:** `pnc.markers.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [Clear a marker](https://docs.lmrp.uk/api-reference/pnc-markers/clear-a-marker.md): **Permission:** `pnc.markers.manage`. Needs a signed-in user; service credentials are refused with `USER_REQUIRED`.
- [List staff](https://docs.lmrp.uk/api-reference/staff/list-staff.md): **Permission:** `staff.view`.
- [Get a staff member](https://docs.lmrp.uk/api-reference/staff/get-a-staff-member.md): **Permission:** `staff.view`.
- [Create or update staff membership](https://docs.lmrp.uk/api-reference/staff/create-or-update-staff-membership.md): **Permission:** `admin.manage`.
- [List shifts](https://docs.lmrp.uk/api-reference/shifts/list-shifts.md): **Permission:** Active staff may read their own shifts. Reading anyone else's, or calling without an active staff profile, needs `shifts.view`.
- [Start a shift](https://docs.lmrp.uk/api-reference/shifts/start-a-shift.md): **Permission:** Active staff may start their own shift. Starting one for another profile needs `shifts.manage`.
- [End a shift](https://docs.lmrp.uk/api-reference/shifts/end-a-shift.md): **Permission:** Active staff may end their own shift. Ending another profile's needs `shifts.manage`.
- [List sessions](https://docs.lmrp.uk/api-reference/sessions/list-sessions.md): **Permission:** `sessions.view`.
- [Start a session](https://docs.lmrp.uk/api-reference/sessions/start-a-session.md): **Permission:** `sessions.manage`.
- [End a session](https://docs.lmrp.uk/api-reference/sessions/end-a-session.md): **Permission:** `sessions.manage`.
- [List punishments](https://docs.lmrp.uk/api-reference/moderation/list-punishments.md): **Permission:** `moderation.view` for the general list. `moderation.history` instead when filtering by `targetRobloxId`.
- [Record a warning](https://docs.lmrp.uk/api-reference/moderation/record-a-warning.md): **Permission:** `moderation.warn`.
- [Kick a player](https://docs.lmrp.uk/api-reference/moderation/kick-a-player.md): **Permission:** `moderation.kick`.
- [Ban a player](https://docs.lmrp.uk/api-reference/moderation/ban-a-player.md): **Permission:** `moderation.ban`.
- [List audit entries](https://docs.lmrp.uk/api-reference/audit/list-audit-entries.md): **Permission:** `audit.view`.
- [List accounts](https://docs.lmrp.uk/api-reference/administration/list-accounts.md): **Permission:** `admin.manage`.
- [Set an account's status](https://docs.lmrp.uk/api-reference/administration/set-an-accounts-status.md): **Permission:** `admin.manage`.
- [List roles](https://docs.lmrp.uk/api-reference/administration/list-roles.md): **Permission:** `admin.manage`.
- [Create a role](https://docs.lmrp.uk/api-reference/administration/create-a-role.md): **Permission:** `admin.manage`.
- [Replace a role](https://docs.lmrp.uk/api-reference/administration/replace-a-role.md): **Permission:** `admin.manage`.
- [List service credentials](https://docs.lmrp.uk/api-reference/administration/list-service-credentials.md): **Permission:** `admin.manage`.
- [Issue a service credential](https://docs.lmrp.uk/api-reference/administration/issue-a-service-credential.md): **Permission:** `admin.manage`.
- [Revoke a service credential](https://docs.lmrp.uk/api-reference/administration/revoke-a-service-credential.md): **Permission:** `admin.manage`.
- [Get live server status](https://docs.lmrp.uk/api-reference/erlc/get-live-server-status.md): **Permission:** `server.view`.
- [List players in the server](https://docs.lmrp.uk/api-reference/erlc/list-players-in-the-server.md): **Permission:** `players.view`.
- [Look up a player in the server](https://docs.lmrp.uk/api-reference/erlc/look-up-a-player-in-the-server.md): **Permission:** `players.lookup`.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


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