# Developer API Documentation - [API Integration](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration.md): Sonoran CMS's open API endpoints allow you to utilize the whitelist system, clock in and out users, etc. - [Getting Started](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/getting-started.md): Integrating your gamemode with Sonoran CMS's API will require a couple of things to get started. - [Retrieving Your Credentials](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/getting-started/retrieving-your-credentials.md): All API calls must be authenticated with a community ID and API key. - [API ID System](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/getting-started/api-id-system.md): Setting your account's API ID allows your account to be easily used with the public API. - [Push Events](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/push-events.md): Sonoran CMS pushes event data to your community for further integration possibilities. Learn more below! - [Account Updated](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/push-events/account-updated.md): This push event sends data when an account gets updated. - [Account Kicked](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/push-events/account-kicked.md): This push event sends data when an account gets kicked. - [Account Banned](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/push-events/account-banned.md): This push event sends data when an account gets banned. - [API Endpoints](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints.md): View all of our API endpoints, learn about our data structuring, and integrate your framework with Sonoran CMS. - [General](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general.md): View Sonoran CMS's general API endpoints - [Get Sub Version](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-sub-version.md): This endpoint allows you to check your Sonoran CMS subscription version. - [Check Com API ID](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/check-com-api-id.md): This endpoint allows you to check a community API ID. - [Get Com Account](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-com-account.md): This endpoint allows you to get a community account by account ID, API ID, or username. - [Get Current Clock In](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-current-clock-in.md): This endpoint allows you to get the current clock in for a community account by account ID, API ID, Discord ID, Unique ID, or username. - [Get Accounts](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-accounts.md): This endpoint allows you to get community accounts paginated by sysStatus, comStatus, banned and archived. - [Get Departments](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-departments.md): Provides all departments and their ranks (and their associated IDs) - [Get Profile Fields](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-departments-1.md): Provides all profile fields associated and configured by the community. - [Get Account Ranks](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/get-account-ranks.md): This endpoint allows you to get a community account ranks. - [Set Account Ranks](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/set-account-ranks.md) - [Clock In Out](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/clock-in-out.md): This endpoint allows you to clock in/out a community account. - [Kick Account](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/kick-account.md): This endpoint allows you to kick an account from your community. - [Ban Account](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/ban-account.md): This endpoint allows you to ban an account from your community. - [Edit Account Profile Fields](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/general/ban-account-1.md): This endpoint allows you to edit an account's profile field within your community. - [Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers.md) - [Get Game Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/get-game-servers.md): This endpoint allows you to retrieve your community's server configurations. - [Set Game Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/set-game-servers.md): This endpoint allows you to set your community's server configurations. - [Verify Whitelist](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/verify-whitelist.md): This endpoint allows you to verify the whitelist of a community account. - [Full Whitelist](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/full-whitelist.md): This endpoint allows you to get the full whitelist list for the specified server. - [Activity Tracker Start / Stop](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/activity-tracker-start-stop.md): This endpoint allows you to start, stop or clear an activity tracker for a CMS user. - [Activity Tracker Server Start](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/servers/activity-tracker-server-start.md): This endpoint allows you to stop all current activity trackers for the specified server ID. - [Events](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/events.md) - [RSVP](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/events/rsvp.md): This endpoint allows you to toggle RSVP with an event from a community. - [Rosters](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/rosters.md): View Sonoran CMS's roster API endpoints - [Get Roster Contents](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/rosters/get-roster-contents.md): This endpoint allows you to get a community columns and rows with pagination. - [Disciplinary](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary.md): View Sonoran CMS's disciplinary API endpoints - [Get Member Points](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary/get-member-points.md): This endpoint allows you to get a member's disciplinary points - [Get Member Records](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary/get-roster-contents.md): This endpoint allows you to get a member's disciplinary records - [Add Member Record](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary/add-member-record.md): This endpoint allows you to add a disciplinary record to a member - [Update Member Record Points](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary/add-member-record-1.md): This endpoint allows you to update a disciplinary record's points - [Update Member Record Reason](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/disciplinary/add-member-record-2.md): This endpoint allows you to update a disciplinary record's reason - [Forms](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/forms.md): View Sonoran CMS's forms API endpoints - [Get Form Submissions](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/forms/get-form-submissions.md): This endpoint allows you to get form submissions for a specific template from your community. - [Get Form Lock Status](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/forms/get-form-lock-status.md): This endpoint allows you to get the form lock status for a specific template from your community. - [Set Form Lock Status](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/forms/set-form-lock-status.md): This endpoint allows you to set the form lock status for a specific template from your community. - [Sessions](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/sessions.md): View Sonoran CMS's sessions API endpoints - [Get Current Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/sessions/get-current-session.md): This endpoint allows you to get the current session for the specified server ID. - [Start Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/sessions/start-session.md): This endpoint allows you to start a new session for the specified server ID. - [Stop Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/sessions/stop-session.md): This endpoint allows you to stop the current session for the specified server ID. - [Cancel Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/sessions/cancel-session.md): This endpoint allows you to cancel the current session for the specified server ID. - [API Endpoints V2](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2.md): REST-style v2 API documentation for Sonoran CMS. - [Libraries](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/libraries.md): Install links for the official Sonoran SDK libraries used with the v2 API. - [General](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general.md): General endpoints for the v2 API. - [Get Community](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-community.md): Retrieve the current community summary. - [Get Sub Version](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-sub-version.md): Retrieve the community subscription tier. - [Lookup Community](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/lookup-community.md): Look up the community by ID or UUID. - [Get Departments](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-departments.md): Retrieve the community departments. - [Get Profile Fields](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-profile-fields.md): Retrieve the configured profile fields. - [Get Clock In Types](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-clockin-types.md): Retrieve the configured clock-in types. - [Get Custom Log Types](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-custom-log-types.md): Retrieve the configured custom log types. - [Get Promotion Flows](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-promotion-flows.md): Retrieve the configured promotion flows. - [Trigger Promotion Flows](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/trigger-promotion-flows.md): Trigger one or more promotion flow actions. - [Undo Rank Change](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/undo-rank-change.md): Undo a previously recorded rank change. - [Create Short URL](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/create-short-url.md): Create a short URL for the community. - [Accounts](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts.md): Accounts endpoints for the v2 API. - [Get Accounts](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-accounts.md): Retrieve a list of community accounts. - [Search Accounts](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/search-accounts.md): Search for community accounts. - [Get Account](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account.md): Retrieve a single community account. - [Get Account Ranks](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account-ranks.md): Retrieve the ranks assigned to an account. - [Get Account Identifiers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account-identifiers.md): Retrieve the identifiers stored for an account. - [Register Identifiers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/register-identifiers.md): Register one or more identifiers for an account. - [Set Account Name](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/set-account-name.md): Update the display name for an account. - [Set Account Ranks](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/set-account-ranks.md): Update the ranks assigned to an account. - [Edit Profile Fields](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/edit-profile-fields.md): Update profile field values for an account. - [Clock Account](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/clock-account.md): Clock an account in or out. - [Get Current Clock In](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-current-clock-in.md): Retrieve the current clock-in state for an account. - [Get Latest Activity](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-latest-activity.md): Retrieve the latest activity for an account. - [Force Sync](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/force-sync.md): Force a sync for an account. - [Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers.md): Servers endpoints for the v2 API. - [Get Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/get-servers.md): Retrieve the configured servers. - [Set Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-servers.md): Replace the configured server list. - [Add Servers](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/add-servers.md): Append one or more servers to the configuration. - [Get ACE Config](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/get-ace-config.md): Retrieve the ACE configuration for a server. - [Set ACE Config](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-ace-config.md): Update the ACE configuration for a server. - [Set Server Type](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-server-type.md): Update the server type. - [Verify Whitelist](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/verify-whitelist.md): Check whether an account is whitelisted on a server. - [Full Whitelist](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/full-whitelist.md): Retrieve the full whitelist for a server. - [Activity Tracker](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/activity-tracker.md): Record a server activity event. - [Activity Tracker Server Start](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/activity-tracker-server-start.md): Start activity tracking for a server. - [Events](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/events.md): Events endpoints for the v2 API. - [RSVP](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/events/rsvp.md): Create an RSVP for an event. - [Forms](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms.md): Forms endpoints for the v2 API. - [Change Form Stage](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/change-stage.md): Move a form submission to a new stage. - [Get Template Submissions](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/get-template-submissions.md): Retrieve submissions for a form template. - [Get Form Lock Status](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/get-lock-status.md): Retrieve the lock status for a form template. - [Set Form Lock Status](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/set-lock-status.md): Update the lock status for a form template. - [Get Submission](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/get-submission.md): Retrieve a single form submission. - [Rosters](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/rosters.md): Rosters endpoints for the v2 API. - [Get Roster Contents](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/rosters/get-roster-contents.md): Retrieve the contents of a roster. - [Disciplinary](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary.md): Disciplinary endpoints for the v2 API. - [Get Member Points](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/get-member-points.md): Retrieve disciplinary point totals for a member. - [Get Member Records](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/get-member-records.md): Retrieve disciplinary records for a member. - [Add Member Record](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/add-member-record.md): Create a disciplinary record. - [Update Member Record Points](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/update-member-record-points.md): Update the points on a disciplinary record. - [Update Member Record Reason](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/update-member-record-reason.md): Update the reason on a disciplinary record. - [Update Member Record Status](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/update-member-record-status.md): Update the status of a disciplinary record. - [ERLC](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc.md): ERLC endpoints for the v2 API. - [Get Online Players](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/get-online-players.md): Retrieve the online ER:LC players. - [Get Player Queue](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/get-player-queue.md): Retrieve the ER:LC queue. - [Add ERLC Record](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/add-record.md): Create an ER:LC record. - [Execute Command](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/execute-command.md): Execute an ER:LC command. - [Lock Team](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/lock-team.md): Lock an ER:LC team. - [Unlock Team](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/unlock-team.md): Unlock an ER:LC team. - [Sessions](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions.md): Sessions endpoints for the v2 API. - [Get Current Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/get-current-session.md): Retrieve the current session for a server. - [Start Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/start-session.md): Start a new session. - [Stop Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/stop-session.md): Stop an active session. - [Cancel Session](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/cancel-session.md): Cancel an active session. - [Rate Limits](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints-v2/rate-limits.md): Rate limits for the v2 API. - [Development Branch](https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/development-branch.md): Sonoran CMS provides a dedicated development API server and web version to work directly with our communities. Find out more information below! --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sonoransoftware.com/cms/developer-api-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.