Account

Retrieves accounts with details.

get

Retrieves accounts with details.

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Query parameters
pageIndexinteger · int32Optional

Page number.

Default: 1
pageSizeinteger · int32Optional

Accounts per page.

Default: 10
searchTermstringOptional

Optional search filter.

rolestring · enumOptional

Optional account role

Possible values:
Responses
200

OK

application/json
get
/Account
GET /api/Account HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": {
    "index": 1,
    "size": 1,
    "totalCount": 1,
    "totalPages": 1,
    "hasNext": true,
    "hasPrevious": true
  },
  "accounts": [
    {
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text",
      "email": "text",
      "createdAt": "2025-12-04T19:12:26.266Z",
      "updatedAt": "2025-12-04T19:12:26.266Z",
      "isActive": true,
      "roles": [
        "Candidate"
      ],
      "profile": {
        "profileId": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "text",
        "lastName": "text",
        "bioMarkdown": "text",
        "instituteName": "text",
        "phoneNumber": "text",
        "imageFile": {
          "cloudFileId": "123e4567-e89b-12d3-a456-426614174000",
          "fileId": "text",
          "name": "text",
          "contentType": "text",
          "size": 1,
          "webContentLink": "text",
          "webViewLink": "text",
          "directLink": "text",
          "createdAt": "2025-12-04T19:12:26.266Z"
        },
        "profileLinks": [
          {
            "profileLinkId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "link": "text"
          }
        ]
      }
    }
  ]
}

Changes active status of an account.

patch

Changes active status of an account.

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Path parameters
accountIdstring · uuidRequired

Account ID to change active status.

Responses
200

OK

application/json
patch
/Account/ChangeActiveStatus/{accountId}
PATCH /api/Account/ChangeActiveStatus/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "text",
  "email": "text",
  "createdAt": "2025-12-04T19:12:26.266Z",
  "updatedAt": "2025-12-04T19:12:26.266Z",
  "isActive": true
}

Updates details of an account.

patch

Updates details of an account.

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Body
accountIdstring · uuidOptional
usernamestring | nullableOptional
emailstring | nullableOptional
Responses
200

OK

application/json
patch
/Account/Update
PATCH /api/Account/Update HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "text",
  "email": "text"
}
{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "text",
  "email": "text",
  "createdAt": "2025-12-04T19:12:26.266Z",
  "updatedAt": "2025-12-04T19:12:26.266Z",
  "isActive": true,
  "roles": [
    "Candidate"
  ],
  "profile": {
    "profileId": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text",
    "bioMarkdown": "text",
    "instituteName": "text",
    "phoneNumber": "text",
    "imageFile": {
      "cloudFileId": "123e4567-e89b-12d3-a456-426614174000",
      "fileId": "text",
      "name": "text",
      "contentType": "text",
      "size": 1,
      "webContentLink": "text",
      "webViewLink": "text",
      "directLink": "text",
      "createdAt": "2025-12-04T19:12:26.266Z"
    },
    "profileLinks": [
      {
        "profileLinkId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "link": "text"
      }
    ]
  }
}

Upgrades a list of accounts to admin.

patch

Upgrades a list of accounts to admin

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Body
accountIdsstring · uuid[] | nullableOptional
Responses
200

OK

No content
patch
/Account/MakeAdmin
PATCH /api/Account/MakeAdmin HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "accountIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
No content

Sends admin invite to a list of email addresses.

post

Sends admin invite to a list of email addresses.

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Body
emailstring[] | nullableOptional
Responses
200

OK

No content
post
/Account/SendAdminInvite
POST /api/Account/SendAdminInvite HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "email": [
    "text"
  ]
}
No content

Deletes an account.

delete

Deletes an account.

Authorizations
AuthorizationstringRequired

🗝️ Admin Account

eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJBY2NvdW50SWQiOiIxMTExMTExMS0xMTExLTExMTEtMTExMS0xMTExMTExMTExMTEiLCJVc2VybmFtZSI6ImFkbWluIiwiRW1haWwiOiJhZG1pbkB0cnVldGVzdC50ZWNoIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkNhbmRpZGF0ZSIsIkFkbWluIl0sIlBlcm1pc3Npb24iOlsiQWNjZXNzT3duRXhhbXMiLCJTdWJtaXRBbnN3ZXJzIiwiUnVuQ29kZSIsIk1hbmFnZU93blByb2ZpbGUiLCJNYW5hZ2VBY2NvdW50cyIsIlZpZXdFeGFtcyIsIk1hbmFnZUV4YW1zIiwiTWFuYWdlUXVlc3Rpb25zIiwiVmlld1N1Ym1pc3Npb25zIiwiUmV2aWV3U3VibWlzc2lvbiJdLCJleHAiOjQ4OTkwMzMxOTUsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0In0.VBPngQIwsybHrwZPYMA5sNpWew3S9_W7cDdpAD4mDyM

Path parameters
accountIdstring · uuidRequired

Account ID.

Responses
200

OK

No content
delete
/Account/Delete/{accountId}
DELETE /api/Account/Delete/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousAPI DocumentationNextAiPrompt

Last updated