Get a List of Users

Curated Reference

This page is maintained from curated documentation data.

GETapollo.apollo_get_users_search

Get a List of Users (GET /users/search). Notes: master_api_key_required.

Request Body

{
  "jsonrpc": "2.0",
  "id": "apollo-apollo-get-users-search-example",
  "method": "tools/call",
  "params": {
    "name": "apollo.apollo_get_users_search",
    "arguments": {
      "params": {
        "page": 1,
        "per_page": 25
      }
    }
  }
}

Arguments Schema

{
  "type": "object",
  "properties": {
    "path_params": {
      "type": "object",
      "additionalProperties": true
    },
    "params": {
      "type": "object",
      "additionalProperties": true
    },
    "body": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "null"
        }
      ]
    },
    "compact": {
      "type": "boolean"
    },
    "include_raw": {
      "type": "boolean"
    },
    "max_items": {
      "type": "number",
      "minimum": 1
    },
    "confirm": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://madpanda3d.com/lab/mad-mcps/portal/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "apollo-apollo-get-users-search-example",
  "method": "tools/call",
  "params": {
    "name": "apollo.apollo_get_users_search",
    "arguments": {
      "params": {
        "page": 1,
        "per_page": 25
      }
    }
  }
}'

Node.js

const response = await fetch('https://madpanda3d.com/lab/mad-mcps/portal/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "apollo-apollo-get-users-search-example",
  "method": "tools/call",
  "params": {
    "name": "apollo.apollo_get_users_search",
    "arguments": {
      "params": {
        "page": 1,
        "per_page": 25
      }
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://madpanda3d.com/lab/mad-mcps/portal/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "apollo-apollo-get-users-search-example",
  "method": "tools/call",
  "params": {
    "name": "apollo.apollo_get_users_search",
    "arguments": {
      "params": {
        "page": 1,
        "per_page": 25
      }
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "endpoint": "/users/search",
  "method": "GET"
}

401 Invalid Apollo API Key

{
  "ok": false,
  "classification": "missing_required_credentials",
  "message": "Apollo API key is missing or invalid."
}