Members
Search members, fetch one by Discord ID, and get a member's effective permissions on a server.
Member lookups and cross-server views
Search members
/api/servers/{serverId}/membersSearch and filter members in a server with pagination. Requires the read_members scope granted for this specific server.
Authentication: Project API key (X-API-Key header)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
serverId | path | string | yes | Discord server ID |
query | query | string | no | Partial match on username, global name, or display name |
roleId | query | string | no | Filter by Discord role snowflake ID |
page | query | number | no | Page number (min 1) Default: 1. |
limit | query | number | no | Items per page (1-100) Default: 20. |
isClubMember | query | boolean | no | Filter by club membership status |
isActive | query | boolean | no | Filter by active server membership status |
Responses
| Status | Description | Body |
|---|---|---|
200 | Paginated list of matching members. | object |
400 | Invalid query parameters. | |
401 | Missing or invalid API key. | |
403 | Project does not have access to this server, or missing read_members scope for this server. |
Open in Swagger (opens in a new tab)
Get a single member by Discord ID
/api/servers/{serverId}/members/{discordId}Returns detailed profile of a member including all roles in the specified server. Requires the read_members scope granted for this specific server.
Authentication: Project API key (X-API-Key header)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
serverId | path | string | yes | Discord server ID |
discordId | path | string | yes | Discord user ID |
Responses
| Status | Description | Body |
|---|---|---|
200 | Member found. | MemberResponseDto |
400 | Invalid Discord ID format. | |
401 | Missing or invalid API key. | |
403 | Project does not have access to this server, or missing read_members scope for this server. | |
404 | Member not found in this server. |
Open in Swagger (opens in a new tab)
Get all effective permissions of a member in a server
/api/servers/{serverId}/members/{discordId}/permissionsRequires the read_members scope granted for this specific server.
Authentication: Project API key (X-API-Key header)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
serverId | path | string | yes | Discord server ID |
discordId | path | string | yes | Discord user ID |
Responses
| Status | Description | Body |
|---|---|---|
200 | Effective permissions returned. | object |
400 | Invalid Discord ID format. | |
401 | Missing or invalid API key. | |
403 | Project does not have access to this server. |
Open in Swagger (opens in a new tab)
Schemas
MemberResponseDto schema
| Field | Type | Required | Description |
|---|---|---|---|
avatar | string | no | Avatar URL |
discordId | string | yes | Discord user ID |
displayName | string | no | Server nickname |
globalName | string | no | Global display name |
isClubMember | boolean | yes | Whether the member is in the main club server |
joinedAt | string | no | Date the member joined this server |
roles | array of MemberRoleDto | yes | Roles assigned to the member in this server |
username | string | yes | Discord username |
MemberRoleDto schema
| Field | Type | Required | Description |
|---|---|---|---|
color | number | no | Role color in decimal |
id | string | yes | Role ID |
name | string | yes | Role name |
position | number | yes | Role position (higher = more permissions) |
MemberSearchResponseDto schema
| Field | Type | Required | Description |
|---|---|---|---|
avatar | string | no | Avatar URL |
discordId | string | yes | Discord user ID |
displayName | string | no | Server nickname |
globalName | string | no | Global display name |
isClubMember | boolean | yes | Whether the member is in the main club server |
joinedAt | string | no | Date the member joined this server |
username | string | yes | Discord username |
Source: apps/api/openapi.json.