Get Team Members

curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/teams/members \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/teams/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/teams/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/teams/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/teams/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "fullname": "<string>",
        "role": "business_owner",
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}

{
  "success": false,
  "message": "<string>"
}

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>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/teams/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/teams/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/teams/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/teams/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "fullname": "<string>",
        "role": "business_owner",
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}

{
  "success": false,
  "message": "<string>"
}

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

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`pageSize`	integer	Results per page (default: 10, max: 100)
`search`	string	Search by name or email
`status`	string	Filter by status: `active`, `inactive`

Example Response

{
  "status": 200,
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "email": "jane@example.com",
        "fullname": "Jane Doe",
        "role": "initiator",
        "role_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
        "status": "active",
        "invite_status": "accepted",
        "is_owner": false,
        "joined_at": "2024-01-10T08:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 3
    }
  }
}

The role field returns the role name — one of business_owner, business_admin, initiator, or approver. The former collaborator value is now returned as initiator. If you string-match on role names, map "collaborator" to "initiator" and add an "approver" branch. See Get Available Roles for the full role reference.

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

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

Show child attributes

Overview

Banks

Account Lookup

Transactions

Wallet

Beneficiaries

Teams

Account Onboarding

Webhooks

Get Team Members

Example Request

Query Parameters

Example Response

Authorizations

Query Parameters

Response

​Example Request

​Query Parameters

​Example Response

Authorizations

Query Parameters

Response

Example Request

Query Parameters

Example Response