List the org’s members

GET

/orgs/{org}/members

curl --request GET \
  --url https://api.sloose.com/orgs/org_9f3c/members \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

Everybody in the org, with their role, where that role came from, and whether their access has been revoked.

Readable by any member, not just administrators: colleagues are not a secret, and knowing who to ask for a role change is the first thing somebody needs.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

Responses

200

Everybody in the org.

Media typeapplication/json

object

members

required

Array<object>

object

userId

required

string

email

required

string

displayName

required

string | null

role

required

string

Allowed values: operator builder admin owner

roleSource

required

Where the role came from: the CRM profile at sign-in, or set by hand here. A manual role is not reset by signing in again.

string | null

zohoProfile

required

string | null

externalUserId

required

How the org’s CRM knows this member — the Zoho user id. Null for someone who joined another way.

string | null

lastSeenAt

required

string | null

blockedAt

required

When access was revoked. Null while they can still use the org.

string | null

key

additional properties

Example

{
  "members": [
    {
      "role": "operator"
    }
  ]
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}