BrightshoalDocsOpen console
MenuMembers

API reference

Members

The people in your organization and their roles.

List organization members

GET/api/members

The whole organization roster with roles, without pagination. Use a member's user_id to grant them access to a knowledge base. Needs an org-wide key: a project-scoped key gets 403 project_key_not_allowed. Read-only keys are allowed.

Secret API key, org-wide (not pinned to a project). How it works

Returns

200 OK

Response attributes
  • dataarray of OrgMemberrequired

    5 attributes
    • user_idstringrequired

    • emailstringrequiredemail

    • namestring | nullrequired

    • rolestringrequired

      One of viewer member admin owner

    • created_atstringrequiredISO 8601 timestamp

  • 401 Missing, malformed, unknown or revoked API key (unauthorized)
  • 403 project_key_not_allowed: this route needs an org-wide API key
  • 429 Rate limit exceeded (rate_limited). Wait Retry-After seconds. Budgets are per 60-second window: developer API 120 per key and 600 per organization; public chat 30 per IP address, except polling for updates (60 per conversation and IP address) and analytics events (120 per IP address).
GET /api/members
curl "https://api.myleadsfactory.tech/api/members" \
  -H "Authorization: Bearer $MLF_API_KEY"
Response 200
{
  "data": [
    {
      "user_id": "id_5f0c2a9e7b1d4c3e8a6f0b2d4c6e8a1f",
      "email": "ana@example.com",
      "name": "Front desk",
      "role": "viewer",
      "created_at": "2026-10-28T09:30:00.000Z"
    }
  ]
}