Returning.AIDevelopers
v1

API reference / Legacy / Servers

.md

List servers

List servers

Last updated 26 Sep 2026API v1

Method
GET
Path
https://api.returning.ai/servers

Authentication#

Header
Authorization: Bearer <API_KEY>

Behaviour#

Legacy category

This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.

What it is for

List servers.

How to use it

Send a GET request to /servers with the documented body, query parameters, headers, or multipart fields. Prefer the newer authenticated /v1/... integration API where available.

Successful response

HTTP 2xx. Older endpoints may return a legacy response envelope or a resource-specific payload rather than the newer { status, message, data } wrapper.

Common error states
  • 400 invalid request body, query, ObjectId, pagination, file format, or missing required field.
  • 401 missing, invalid, expired, or insufficient API key/token.
  • 403 key is valid but cannot access this community/channel/user/resource, where supported by the service.
  • 404 route or target resource was not found. Several legacy root routes return 404 on https://api.returning.ai; confirm with Returning.AI before using them.
  • 409 duplicate or conflicting state for create/update operations, where applicable.
  • 500 unexpected Returning.AI service error.
Legacy status

Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current /v1/... endpoint in the matching non-Legacy category when one exists.

Request#

Headers#

Authorization#stringREQUIRED
API key.

RuleBearer <API_KEY>

curl --request GET \
  --url https://api.returning.ai/servers \
  --header 'Authorization: Bearer <API_KEY>'

Response#

meta#objectALWAYS

Eg{ ... }

success#booleanALWAYS

Egtrue

message#stringALWAYS

Eg"My servers"

devMessage#stringALWAYS

Eg"My servers"

body#object[]ALWAYS

Eg[ ... ]

_id#string

Eg"{_id}"

name#string

Eg"Dummy Server"

image#string

Eg"https://dummyimage.com/600x400/000/fff"

owner#object

Eg{"id": "2"}

id#stringALWAYS

Eg"2"

__v#integer

Eg0

roles#string[]

Eg[]

categories#string[]

Eg[]

leaderboards#string[]

Eg[]

languageSettings#string[]

Eg[]

id#string

Eg"{_id}"

{
  "meta": {
    "success": true,
    "message": "My servers",
    "devMessage": "My servers"
  },
  "body": [
    {
      "_id": "{_id}",
      "name": "Dummy Server",
      "image": "https://dummyimage.com/600x400/000/fff",
      "owner": {
        "id": "2"
      },
      "__v": 0,
      "roles": [],
      "categories": [],
      "leaderboards": [],
      "languageSettings": [],
      "id": "{_id}"
    }
  ]
}

Errors#

Fix the request01

401Fix the request
Missing, invalid, expired, or insufficient API key/token. Older permission middleware may also return 401 for missing permissions.

Fix the data01

404Fix the data
The requested resource, route, community, channel, user, API key, status, or job was not found.

Retry with backoff01

500Retry with backoff
Unexpected Returning.AI service error.
{
  "status": "fail",
  "message": "Missing, invalid, expired, or insufficient API key/token. Older permission middleware may also return 401 for missing permissions."
}

Next step#

Update server metadataPUT/servers