Groups

Read Groups

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/groups/

HTTPcURLJavaScriptPython

GET /api/groups/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "org_id": 1,
      "name": "text",
      "description": "text",
      "source": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Add Group

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

descriptionstringRequired

sourcestringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/groups/

HTTPcURLJavaScriptPython

POST /api/groups/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "name": "text",
  "description": "text",
  "source": "text"
}

{
  "id": 1,
  "org_id": 1,
  "name": "text",
  "description": "text",
  "source": "text"
}

Delete Group

delete

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

group_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

/api/groups/{group_id}

HTTPcURLJavaScriptPython

DELETE /api/groups/{group_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

Link User

put

Authorizations

SessionCookieHTTPBearer

cookiestringRequired

Path parameters

group_idintegerRequired

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

put

/api/groups/{group_id}/{user_id}

HTTPcURLJavaScriptPython

PUT /api/groups/{group_id}/{user_id} HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "message": "text"
}

Unlink User

delete

Authorizations

SessionCookieHTTPBearer

cookiestringRequired

Path parameters

group_idintegerRequired

user_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

/api/groups/{group_id}/{user_id}

HTTPcURLJavaScriptPython

DELETE /api/groups/{group_id}/{user_id} HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "message": "text"
}