List an organization's members

curl --request GET \
  --url https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "uid": "user123",
    "orgId": "org_ab12cd34",
    "email": "member@example.com",
    "username": "Member One",
    "teams": [
      "Team A"
    ],
    "isAdmin": false,
    "status": "Activated",
    "current_email": "member.new@example.com"
  }
]

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "not-found",
  "error_msg": "Org '<org_id>' not found"
}

{
  "error": "unprocessable-entity",
  "error_msg": "body.<field>: <validation message>"
}

{
  "error": "rate-limited",
  "error_msg": "Rate limit exceeded. Retry after <n> seconds."
}

{
  "error": "internal-server-error",
  "error_msg": "Failed to fetch data: <error_message>"
}

Organization Members

List an organization's members

List every member on an organization’s roster.

The list is not filtered by status: members whose invitation is still Invitation Pending are included alongside Activated ones. Data endpoints, by contrast, reach only members who have accepted.

Parameters

org_id (path, required) - organization identifier.

Response

200 returns an array of roster documents (uid, orgId, email, username, teams, isAdmin, status), each with current_email added. A document whose data sharing was set through PUT /api/orgs/{org_id}/orgUsers/{uid}?allowDataSharing= also carries allowDataSharing. email is the address stored on the roster document; current_email is the address SOXAI Authentication holds for the member at the time of the request, or null when the member has no SOXAI Authentication account or the address could not be read from SOXAI Authentication.

Errors

Status	Condition
404	The organization does not exist. An organization with no members answers `[]`, so the existence of the organization is only established when there is nothing to return

Authorization

Scheme: Authorization: Bearer <idToken> or soxai-api-key: <api key>.
Accepted roles: PartnerAdmin, OrgAdmin, OrgUser
Admin is accepted regardless of the roles above.
PartnerAdmin reaches only an org owned by its own company; any other caller must carry an orgId claim naming exactly {org_id}.
Denials: a PartnerAdmin naming another company’s org receives 403 PartnerAdmin can change only the org that belongs to your company; a caller whose orgId claim does not name {org_id} receives 403 orgId not match; anyone else receives 403 Not enough permission.

GET

api

orgs

{org_id}

orgUsers

List an organization's members

curl --request GET \
  --url https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "uid": "user123",
    "orgId": "org_ab12cd34",
    "email": "member@example.com",
    "username": "Member One",
    "teams": [
      "Team A"
    ],
    "isAdmin": false,
    "status": "Activated",
    "current_email": "member.new@example.com"
  }
]

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "not-found",
  "error_msg": "Org '<org_id>' not found"
}

{
  "error": "unprocessable-entity",
  "error_msg": "body.<field>: <validation message>"
}

{
  "error": "rate-limited",
  "error_msg": "Rate limit exceeded. Retry after <n> seconds."
}

{
  "error": "internal-server-error",
  "error_msg": "Failed to fetch data: <error_message>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id

string

required

Organization ID.

Example:

"org_123"

Response

The organization's roster. An organization with no members answers with an empty array.

Get started

API Reference (Sandbox)

API Reference (Production)

About

List an organization's members

Authorizations

Path Parameters

Response