# Developer API Documentation

- [API Integration](/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](/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](/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](/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](/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](/cms/developer-api-documentation/api-integration/push-events/account-updated.md): This push event sends data when an account gets updated.
- [Account Kicked](/cms/developer-api-documentation/api-integration/push-events/account-kicked.md): This push event sends data when an account gets kicked.
- [Account Banned](/cms/developer-api-documentation/api-integration/push-events/account-banned.md): This push event sends data when an account gets banned.
- [API Endpoints V2](/cms/developer-api-documentation/api-integration/api-endpoints-v2.md): REST-style v2 API documentation for Sonoran CMS.
- [Libraries](/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](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general.md): General endpoints for the v2 API.
- [Get Community](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-community.md): Retrieve the current community summary.
- [Get Sub Version](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-sub-version.md): Retrieve the community subscription tier.
- [Lookup Community](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/lookup-community.md): Look up the community by ID or UUID.
- [Get Departments](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-departments.md): Retrieve the community departments.
- [Get Profile Fields](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-profile-fields.md): Retrieve the configured profile fields.
- [Get Clock In Types](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-clockin-types.md): Retrieve the configured clock-in types.
- [Get Custom Log Types](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-custom-log-types.md): Retrieve the configured custom log types.
- [Get Promotion Flows](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/get-promotion-flows.md): Retrieve the configured promotion flows.
- [Trigger Promotion Flows](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/trigger-promotion-flows.md): Trigger one or more promotion flow actions.
- [Undo Rank Change](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/undo-rank-change.md): Undo a previously recorded rank change.
- [Create Short URL](/cms/developer-api-documentation/api-integration/api-endpoints-v2/general/create-short-url.md): Create a short URL for the community.
- [Accounts](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts.md): Accounts endpoints for the v2 API.
- [Get Accounts](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-accounts.md): Retrieve a list of community accounts.
- [Search Accounts](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/search-accounts.md): Search for community accounts.
- [Get Account](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account.md): Retrieve a single community account.
- [Get Account Ranks](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account-ranks.md): Retrieve the ranks assigned to an account.
- [Get Account Identifiers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-account-identifiers.md): Retrieve the identifiers stored for an account.
- [Register Identifiers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/register-identifiers.md): Register one or more identifiers for an account.
- [Set Account Name](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/set-account-name.md): Update the display name for an account.
- [Set Account Ranks](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/set-account-ranks.md): Update the ranks assigned to an account.
- [Edit Profile Fields](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/edit-profile-fields.md): Update profile field values for an account.
- [Clock Account](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/clock-account.md): Clock an account in or out.
- [Get Current Clock In](/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](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/get-latest-activity.md): Retrieve the latest activity for an account.
- [Force Sync](/cms/developer-api-documentation/api-integration/api-endpoints-v2/accounts/force-sync.md): Force a sync for an account.
- [Servers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers.md): Servers endpoints for the v2 API.
- [Get Servers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/get-servers.md): Retrieve the configured servers.
- [Set Servers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-servers.md): Replace the configured server list.
- [Add Servers](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/add-servers.md): Append one or more servers to the configuration.
- [Get ACE Config](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/get-ace-config.md): Retrieve the ACE configuration for a server.
- [Set ACE Config](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-ace-config.md): Update the ACE configuration for a server.
- [Set Server Type](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/set-server-type.md): Update the server type.
- [Verify Whitelist](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/verify-whitelist.md): Check whether an account is whitelisted on a server.
- [Full Whitelist](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/full-whitelist.md): Retrieve the full whitelist for a server.
- [Activity Tracker](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/activity-tracker.md): Record a server activity event.
- [Activity Tracker Server Start](/cms/developer-api-documentation/api-integration/api-endpoints-v2/servers/activity-tracker-server-start.md): Start activity tracking for a server.
- [Events](/cms/developer-api-documentation/api-integration/api-endpoints-v2/events.md): Events endpoints for the v2 API.
- [RSVP](/cms/developer-api-documentation/api-integration/api-endpoints-v2/events/rsvp.md): Create an RSVP for an event.
- [Forms](/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms.md): Forms endpoints for the v2 API.
- [Change Form Stage](/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/change-stage.md): Move a form submission to a new stage.
- [Get Template Submissions](/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/get-template-submissions.md): Retrieve submissions for a form template.
- [Get Form Lock Status](/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](/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/set-lock-status.md): Update the lock status for a form template.
- [Get Submission](/cms/developer-api-documentation/api-integration/api-endpoints-v2/forms/get-submission.md): Retrieve a single form submission.
- [Rosters](/cms/developer-api-documentation/api-integration/api-endpoints-v2/rosters.md): Rosters endpoints for the v2 API.
- [Get Roster Contents](/cms/developer-api-documentation/api-integration/api-endpoints-v2/rosters/get-roster-contents.md): Retrieve the contents of a roster.
- [Disciplinary](/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary.md): Disciplinary endpoints for the v2 API.
- [Get Member Points](/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/get-member-points.md): Retrieve disciplinary point totals for a member.
- [Get Member Records](/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/get-member-records.md): Retrieve disciplinary records for a member.
- [Add Member Record](/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/add-member-record.md): Create a disciplinary record.
- [Update Member Record Points](/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](/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](/cms/developer-api-documentation/api-integration/api-endpoints-v2/disciplinary/update-member-record-status.md): Update the status of a disciplinary record.
- [ERLC](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc.md): ERLC endpoints for the v2 API.
- [Get Online Players](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/get-online-players.md): Retrieve the online ER:LC players.
- [Get Player Queue](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/get-player-queue.md): Retrieve the ER:LC queue.
- [Add ERLC Record](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/add-record.md): Create an ER:LC record.
- [Execute Command](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/execute-command.md): Execute an ER:LC command.
- [Lock Team](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/lock-team.md): Lock an ER:LC team.
- [Unlock Team](/cms/developer-api-documentation/api-integration/api-endpoints-v2/erlc/unlock-team.md): Unlock an ER:LC team.
- [Sessions](/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions.md): Sessions endpoints for the v2 API.
- [Get Current Session](/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/get-current-session.md): Retrieve the current session for a server.
- [Start Session](/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/start-session.md): Start a new session.
- [Stop Session](/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/stop-session.md): Stop an active session.
- [Cancel Session](/cms/developer-api-documentation/api-integration/api-endpoints-v2/sessions/cancel-session.md): Cancel an active session.
- [Rate Limits](/cms/developer-api-documentation/api-integration/api-endpoints-v2/rate-limits.md): Rate limits for the v2 API.
- [Development Branch](/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!