Purpose
GET
/dmsList all DM channels (private channels).
Returns both 1:1 DMs and group DMs.
- recipient_name: Optionally filter 1:1 DMs by username or display name
Authentication
Send a tenant API key as Authorization: Bearer <key> or X-API-Key: <key>. Keep keys server-side and use the account slug for the connected Discord account.
Parameters
NameInRequiredType / constraints
recipient_name
query
optional
string ยท default null
Request example
Replace the tenant, account, and resource placeholders before running this read-only request.
curl --fail-with-body \
-H "Authorization: Bearer ${DATAZ_API_KEY}" \
"https://dataz.md/gateway/v1/{tenant_slug}/accounts/{account_slug}/dms"
Response schema
Documented responses
200Response model: List[DMChannel]List[DMChannel]
Response example
Representative JSON shape. The live response can include additional documented fields.
[
{
"id": "123456789012345678",
"recipient_id": "123456789012345678",
"recipient_name": "example_user",
"recipient_display_name": "Example User",
"type": 1
}
]
Errors
Common responses
401Missing or invalid tenant API key.authentication
403The tenant, account, or connected provider cannot access the requested resource.authorization
404The route or requested provider resource was not found.not found
422A path or query parameter is invalid.validation
429Rate limited; wait for the Retry-After interval before retrying.rate limit
Limits and pagination
- This endpoint does not expose cursor pagination in its current public contract.
- Provider or demo limits can return HTTP 429. Wait for the
Retry-Afterinterval before retrying.
Related tutorials
Read-only notes
This reference page documents a public GET endpoint. Setup/token, AI, dev, internal, and mutating routes are excluded from static reference generation.