get__organization_users

GET /organization/users

List Organization Users

Retrieve a list of all users in the authenticated user's organization. This endpoint requires user management permissions (WORKSPACES role or higher).

TypeScript Client Library

// Note: This endpoint doesn't have a direct client method in the provided TypeScript client
// You would need to use the generic makeRequest method:
// this.makeRequest<any>('organization/users', 'GET', null);

Code Samples

# You can also use wget
curl -X GET https://backend.flashback.tech/organization/users \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "[email protected]",
      "name": "John",
      "lastName": "Doe",
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "orgRole": 2,
      "validated": true,
      "deletedAt": null,
      "orgRoleDescription": "WORKSPACES",
      "orgRoles": [0, 1, 2]
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "email": "[email protected]",
      "name": "Jane",
      "lastName": "Smith",
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "orgRole": 0,
      "validated": true,
      "deletedAt": null,
      "orgRoleDescription": "USER",
      "orgRoles": [0]
    }
  ],
  "total": 2
}

403 Response

{
  "success": false,
  "data": [],
  "total": 0
}

500 Response

{
  "success": false,
  "data": [],
  "total": 0
}

Responses

Status
Meaning
Description
Schema

200

Users retrieved successfully

Inline

403

Insufficient permissions or user not in organization

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

array

false

none

Array of organization users

»» id

string

false

none

Unique identifier for the user

»» email

string

false

none

User's email address

»» name

string

false

none

User's first name

»» lastName

string

false

none

User's last name

»» orgId

string

false

none

Organization identifier

»» orgRole

integer

false

none

User's organization role (0x00-0xff)

»» validated

boolean

false

none

Whether the user's email is validated

»» deletedAt

string (date-time)

false

none

Deletion timestamp (null if active)

»» orgRoleDescription

string

false

none

Human-readable role description

»» orgRoles

[integer]

false

none

Array of available roles for the user

» total

integer

false

none

Total number of users in the organization

Status Code 403

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

array

false

none

Empty array (no users returned)

» total

integer

false

none

Total count (0)

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

array

false

none

Empty array (no users returned)

» total

integer

false

none

Total count (0)

Enumerated Values

Parameter
Value
Description

» orgRole

0x00

USER - Default role with basic access

» orgRole

0x01

BILLING - Can manage billing and subscriptions

» orgRole

0x02

WORKSPACES - Can manage workspaces and team members

» orgRole

0xfe

ADMINISTRATOR - Administrative access

» orgRole

0xff

OWNER - Full organization access

Security

  • BearerAuth: Bearer token authentication required

  • Permissions: Requires WORKSPACES role or higher to access user management functions

Last updated

Was this helpful?