Skip to main content
GET
/
teams
/
members
Get Team Members
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/teams/members \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "fullname": "<string>",
        "role": "<string>",
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}
Retrieve a paginated list of team members for your business. Filter by status or search by name and email.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/teams/members?page=1&pageSize=10&status=active" \
  -H "X-API-Key: your_api_key_here"

​
Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
pageSizeintegerResults per page (default: 10, max: 100)
searchstringSearch by name or email
statusstringFilter by status: active, inactive

​
Example Response

{
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "email": "jane@example.com",
        "fullname": "Jane Doe",
        "role": "Admin",
        "status": "active",
        "created_at": "2024-01-10T08:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 3
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
pageSize
integer
default:10

Results per page (default: 10, max: 100)

Required range: 1 <= x <= 100
​
search
string

Search by name or email

​
status
enum<string>

Filter by member status

Available options:
active,
inactive

Response

Team members retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Team members retrieved successfully"

​
data
object