Groups

Manage Groups per given Organization via APIs

Add Group

This API endpoint allows users to create a new group within an organization. By providing the organization ID and a group object containing the group details, users can add a new group to the organization. The endpoint returns a success message along with the group ID upon successful creation of the group. In case of an error, the endpoint raises an exception with an routerropriate error message.

POSThttps://app.aquilax.ai/api/v1/organization/{org_id}/group

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Body

application/json

name*Name

descriptionDescription

stringnull

tagsTags

array of stringnull

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Groups

This API endpoint retrieves a list of groups associated with a specific organization. By providing the organization ID, users can fetch all the groups within the organization. The endpoint returns a JSON object containing the list of groups along with their details. If no groups are found, the endpoint returns an empty list.

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/group

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Update Group

This API endpoint allows users to update the details of an existing group within an organization. By providing the group ID, organization ID and a group object containing the updated group details, users can modify the group information. The endpoint returns a success message upon successful completion of the operation. In case of an error, the endpoint raises an exception with an routerropriate error message.

PUThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}

Authorization

Personal Access Token

Path parameters

group_id*Group Id

org_id*Org Id

Body

application/json

name*Name

descriptionDescription

stringnull

tagsTags

array of stringnull

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Group

This API endpoint retrieves the details of a specific group within an organization. By providing the organization ID and group ID, users can fetch the group details. The endpoint returns a JSON object containing the group information. If the group is not found, the endpoint returns an error message.

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}

Authorization

Personal Access Token

Path parameters

group_id*Group Id

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Delete Group

This API endpoint allows users to delete an existing group within an organization. By providing the group ID and organization ID, users can remove the group from the organization. The endpoint returns a success message upon successful deletion of the group. In case of an error, the endpoint raises an exception with an routerropriate error message.

DELETEhttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}

Authorization

Personal Access Token

Path parameters

group_id*Group Id

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}