List Organization Users

GET 
/api/v1/organizations/:organization_id/users

Get all users in an organization.

Request

Path Parameters

organization_id uuidrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

email emailrequired

The user's email address.

user_id

object

The user's ID.

anyOf

MOD1

string

organization_id uuidrequired

The organization's ID.

pending Pending (boolean)

Default value: true

Whether the user's membership is pending account signup.

invited_by_user_id

object

The user ID of the user who added the user to the organization.

anyOf

MOD1

string

invited_by_user_email

object

The email address of the user who added the user to the organization.

anyOf

MOD1

string

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-10-03T01:48:33.234Z",
    "updated_at": "2024-10-03T01:48:33.234Z",
    "email": "user@example.com",
    "user_id": "string",
    "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pending": true,
    "invited_by_user_id": "string",
    "invited_by_user_email": "user@example.com"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...