VirtuousAI
Reference

Organizations

List Organization Members

GET
/api/v1/organizations/members

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/organizations/members"
{
  "items": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Team Members

GET
/api/v1/organizations/team

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/organizations/team"
{
  "currentRoleSlug": "owner",
  "members": [
    {
      "email": "string",
      "firstName": "string",
      "isCurrentUser": true,
      "joinedAt": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "membershipId": "8072cc74-4782-4f2c-827c-699c48ce2092",
      "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
      "roleName": "string",
      "roleSlug": "owner",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Team Member Role

PATCH
/api/v1/organizations/team/members/{membership_id}/role

Path Parameters

membership_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

roleSlug*string
Value in"owner" | "admin" | "member" | "viewer"

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/organizations/team/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/role" \  -H "Content-Type: application/json" \  -d '{    "roleSlug": "owner"  }'
{
  "membershipId": "8072cc74-4782-4f2c-827c-699c48ce2092",
  "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  "roleName": "string",
  "roleSlug": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}