Get Members
GET /v2/servers/:communityId/members
Rate limit: 15 requests per minute
Returns paginated community membership data, including approval state, permission level, and per-profile access.
Headers
| Name | Value |
|---|---|
| Authorization | Bearer <community-api-key> |
| Name | Type | Description |
|---|---|---|
communityId | string | Sonoran Radio community ID |
| Name | Type | Description |
|---|---|---|
page | integer | 1-based page number. Defaults to 1. |
perPage | integer | Page size. Defaults to 25, maximum 100. |
status | string | Optional filter: pending, approved, or banned. |
sortBy | string | Optional sort field: username, displayName, approved, pending, permission, banned, or accId. |
descending | boolean | Set to true to sort descending. |
search | string | Optional search across username, display name, and account ID. |
- Sonoran.lua
- Sonoran.js
- Sonoran.py
- Sonoran.Net
- OpenAPI
- cURL
local response = client.radio:getMembersV2({
page = 1,
perPage = 25,
status = "approved",
sortBy = "username",
search = "dispatch"
}, "YOUR_COMMUNITY_ID")
const response = await instance.radio?.getMembersV2({
page: 1,
perPage: 25,
status: 'approved',
sortBy: 'username',
search: 'dispatch'
}, 'YOUR_COMMUNITY_ID');
response = instance.radio.getMembersV2({
"page": 1,
"perPage": 25,
"status": "approved",
"sortBy": "username",
"search": "dispatch",
}, "YOUR_COMMUNITY_ID")
var response = await sonoran.Radio.getMembersV2(new GetMembersV2Query
{
Page = 1,
PerPage = 25,
Status = "approved",
SortBy = "username",
Search = "dispatch"
});
openapi: 3.0.3
info:
title: Sonoran Radio API v2
version: "1.0"
servers:
- url: https://api.sonoranradio.com
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
paths:
/v2/servers/{communityId}/members:
get:
summary: Get paginated community members
parameters:
- in: path
name: communityId
required: true
schema:
type: string
example: YOUR_COMMUNITY_ID
- in: query
name: page
schema:
type: integer
example: 1
- in: query
name: perPage
schema:
type: integer
example: 25
- in: query
name: status
schema:
type: string
enum: [pending, approved, banned]
- in: query
name: sortBy
schema:
type: string
enum: [username, displayName, approved, pending, permission, banned, accId]
- in: query
name: descending
schema:
type: boolean
example: false
- in: query
name: search
schema:
type: string
example: dispatch
security:
- bearerAuth: []
responses:
"200":
description: Paginated members response
"400":
description: Validation failed
"401":
description: Missing or invalid bearer token
"404":
description: Community not found for this API key
curl -G "https://api.sonoranradio.com/v2/servers/YOUR_COMMUNITY_ID/members" \
-H "Authorization: Bearer your-community-api-key" \
--data-urlencode "page=1" \
--data-urlencode "perPage=25" \
--data-urlencode "status=approved" \
--data-urlencode "sortBy=username" \
--data-urlencode "search=dispatch"
Response
Successful requests returnapplication/json.
{
"members": [
{
"accId": "91de0ce8-c571-11e9-9714-5600023b2434",
"username": "Officer Smith",
"displayName": "Dispatch 101",
"permission": 34,
"profilePerms": [
{
"id": 12,
"profileId": 7,
"canJoin": true
}
],
"approved": true,
"pending": false,
"banned": false
}
],
"pagination": {
"page": 1,
"perPage": 25,
"total": 1,
"totalPages": 1
}
}

