List members

GET/members

Lists the members of an organization by name, with their role, account role and who manages each membership: admin (people in BloomText), api (an API key) or account (an Owner or IT person, in every organization).

Credentials: API key with member scopes
Scope: members.read

Run in Postman: import the collection, set api_key, and find this request in its folder.

Query parameters

org_idUUID

The organization the call acts on, from List organizations. Required when an account API key reaches more than one organization; an organization key or a key limited to one organization can leave it out.

page[limit]integer

Number of records to return. Defaults to 50, maximum 100.

page[after]string

Cursor from the previous page’s pagination.next_cursor.

Returns

Returns 200 OK with a data array of Member objects and a pagination object. See pagination.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

Status	Code	Meaning
400	`invalid_request`	The request is malformed, such as invalid JSON.
400	`org_id_required`	The key reaches more than one organization: pass `org_id`.
401	`invalid_token`	The API key is missing or malformed, or isn’t a BloomText key.
401	`key_revoked`	The API key was revoked.
401	`key_expired`	The API key’s expiry has passed.
403	`insufficient_scope`	The key doesn’t have the scope this endpoint needs.
403	`org_not_reachable`	The key can’t reach the organization in `org_id`.
403	`accounts_not_enabled`	The account layer isn’t turned on for this account yet.
429	`rate_limited`	Too many requests. Retry after `Retry-After` seconds.

cURL

Request


curl "https://api.bloomtext.com/v1/members" \
  -H "Authorization: Bearer $BLOOMTEXT_API_KEY"

JavaScript

Request


const response = await fetch('https://api.bloomtext.com/v1/members', {
  headers: {
    Authorization: `Bearer ${process.env.BLOOMTEXT_API_KEY}`,
  },
})
 
if (!response.ok) throw new Error(`BloomText API error: ${response.status}`)
const data = await response.json()

Python

Request


import os
 
import requests
 
response = requests.get(
    "https://api.bloomtext.com/v1/members",
    headers={
        "Authorization": f"Bearer {os.environ['BLOOMTEXT_API_KEY']}",
    },
)
response.raise_for_status()
data = response.json()

Go

Request


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	req, err := http.NewRequest("GET", "https://api.bloomtext.com/v1/members", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("BLOOMTEXT_API_KEY"))
 
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
 
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

Ruby

Request


require "net/http"
require "json"
 
uri = URI("https://api.bloomtext.com/v1/members")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("BLOOMTEXT_API_KEY")}"
 
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
data = JSON.parse(response.body)

Response · 200 OK


{
  "data": [
    {
      "id": "8b9c2d2f-6b1a-44f4-a7b1-0d6d3f2d6f55",
      "org_id": "8b9c2d2f-6b1a-44f4-a7b1-0d6d3f2d6f55",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "admin",
      "account_role": "owner",
      "managed_by": "admin",
      "managed_by_name": "string"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}