Get Organization Users

Fetch the users of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

GET /api/organization/users/{organization_id}

Try it

Get Organization Users

cURL

curl --request GET \
  --url https://api.trieve.ai/api/organization/users/{organization_id} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Organization: <tr-organization>'

200

[
  {
    "email": "[email protected]",
    "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "name": "Trieve",
    "orgs": [
      {
        "created_at": "2021-01-01 00:00:00.000",
        "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "name": "Trieve",
        "registerable": true,
        "updated_at": "2021-01-01 00:00:00.000"
      }
    ],
    "user_orgs": [
      {
        "created_at": "2021-01-01 00:00:00.000",
        "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "org_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
        "role": 0,
        "updated_at": "2021-01-01 00:00:00.000",
        "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

Headers

TR-Organization · string<uuid> · required

The organization id to use for the request

Path Parameters

organization_id · string<uuid> · required

The id of the organization you want to fetch the users of.

Response

200

application/json

Array of users who belong to the specified by organization

created_at · string<date-time> · required

email · string · required

id · string<uuid> · required

orgs · object[] · required

Show child attributes

orgs. created_at · string<date-time> · required

Timestamp of the creation of the dataset

orgs. deleted · integer<int32> · required

Flag to indicate if the organization has been deleted. Deletes are handled async after the flag is set so as to avoid expensive search index compaction.

orgs. id · string<uuid> · required

Unique identifier of the dataset, auto-generated uuid created by Trieve

orgs. name · string · required

Name of the organization

orgs. partner_configuration · any · required

Configuration of the organization for the Trieve partner program. Contact [email protected] for more details.

orgs. updated_at · string<date-time> · required

Timestamp of the last update of the dataset

orgs. registerable · boolean | null

Flag to indicate whether or not new users may join the organization. Default is true.

user_orgs · object[] · required

Show child attributes

user_orgs. created_at · string<date-time> · required

user_orgs. id · string<uuid> · required

user_orgs. organization_id · string<uuid> · required

user_orgs. role · integer<int32> · required

user_orgs. updated_at · string<date-time> · required

user_orgs. user_id · string<uuid> · required

user_orgs. scopes · (string | null)[] | null

name · string | null