Skip to main content
GET
/
api
/
v1
/
organizations
/
{orgId}
/
members
List Members
curl --request GET \
  --url https://api.bunship.com/api/v1/organizations/{orgId}/members \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.bunship.com/api/v1/organizations/{orgId}/members"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bunship.com/api/v1/organizations/{orgId}/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.bunship.com/api/v1/organizations/{orgId}/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 => [
"Authorization: Bearer <token>"
],
]);

$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.bunship.com/api/v1/organizations/{orgId}/members"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.bunship.com/api/v1/organizations/{orgId}/members")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bunship.com/api/v1/organizations/{orgId}/members")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "members": [
    {
      "id": "mbr_abc123",
      "userId": "usr_cld2abc123def456",
      "organizationId": "org_cld2abc123def456",
      "role": "owner",
      "user": {
        "id": "usr_cld2abc123def456",
        "email": "owner@example.com",
        "fullName": "John Doe",
        "avatarUrl": "https://cdn.bunship.com/avatars/john.jpg"
      },
      "joinedAt": "2024-01-15T10:00:00Z"
    },
    {
      "id": "mbr_def456",
      "userId": "usr_xyz789ghi012345",
      "organizationId": "org_cld2abc123def456",
      "role": "member",
      "user": {
        "id": "usr_xyz789ghi012345",
        "email": "jane@example.com",
        "fullName": "Jane Smith",
        "avatarUrl": null
      },
      "joinedAt": "2024-02-01T14:30:00Z"
    }
  ],
  "total": 2
}
Returns all members of the organization, including their user profile and role. Requires the members:read permission.

Auth

Requires a valid Bearer token with members:read permission.

Path Parameters

orgId
string
required
Organization identifier.

Response

members
array
Array of member objects.
total
number
Total number of members.
{
  "members": [
    {
      "id": "mbr_abc123",
      "userId": "usr_cld2abc123def456",
      "organizationId": "org_cld2abc123def456",
      "role": "owner",
      "user": {
        "id": "usr_cld2abc123def456",
        "email": "owner@example.com",
        "fullName": "John Doe",
        "avatarUrl": "https://cdn.bunship.com/avatars/john.jpg"
      },
      "joinedAt": "2024-01-15T10:00:00Z"
    },
    {
      "id": "mbr_def456",
      "userId": "usr_xyz789ghi012345",
      "organizationId": "org_cld2abc123def456",
      "role": "member",
      "user": {
        "id": "usr_xyz789ghi012345",
        "email": "jane@example.com",
        "fullName": "Jane Smith",
        "avatarUrl": null
      },
      "joinedAt": "2024-02-01T14:30:00Z"
    }
  ],
  "total": 2
}

Errors

StatusCodeDescription
401AUTHENTICATION_ERRORMissing or invalid Bearer token
403AUTHORIZATION_ERRORInsufficient permissions (members:read required)
404NOT_FOUNDOrganization not found

Example

curl https://api.bunship.com/api/v1/organizations/org_cld2abc123def456/members \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."