User Groups

List All User Groups

get https://api.vendloop.com/user_groups

Returns a paginated list of User groups sorted by id in descending order.

Header

Authorization

String

Set value to Bearer SECRET_KEY

limit

integer

Specify how many records you want to retrieve per page. If not specified we use a default value of 50.

curl -L 'https://api.vendloop.com/user_groups/' \
-H 'Authorization: Bearer SECRET_KEY'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.vendloop.com/user_groups',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer SECRET_KEY");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.vendloop.com/user_groups", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

val client = OkHttpClient()
val request = Request.Builder()
  .url("https://api.vendloop.com/user_groups")
  .addHeader("Authorization", "Bearer SECRET_KEY")
  .build()
val response = client.newCall(request).execute()

Sample Response

{
  "status":true,
  "message":"User groups found",
  "data":[
    {
      "id":"7",
      "name":"Waiter",
      "description":"Sales representative"
    }
  ],
  "metadata":{
    "limit":50,
    "start":1,
    "total":1
  }
}

{
  "status": false,
  "message": "User group not found"
}

Fetch a Single User Group

get https://api.vendloop.com/user_groups/{id}

Returns details of a user group with the given ID.

Header

Authorization

String

Set value to Bearer SECRET_KEY

id required

integer

Auto-generated unique ID

curl -L 'https://api.vendloop.com/user_groups/{id}' \
-H 'Authorization: Bearer SECRET_KEY'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.vendloop.com/user_groups/{id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer SECRET_KEY");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.vendloop.com/user_groups/{id}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

val client = OkHttpClient()
val request = Request.Builder()
  .url("https://api.vendloop.com/user_groups/{id}")
  .addHeader("Authorization", "Bearer SECRET_KEY")
  .build()
val response = client.newCall(request).execute()

Sample Response

{
  "status":true,
  "message":"User group found",
  "data":{
    "id":"7",
    "name":"Waiter",
    "description":"Sales representative"
  }
}

{
    "status": false,
    "message": "User group not found"
}

Delete a Single User Group

post https://api.vendloop.com/user_groups/delete

Delete user group with the given ID.

Header

Authorization

String

Set value to Bearer SECRET_KEY

id required

integer

The ID of the user group to be deleted.

curl -L 'http://api.vendloop.com/user_groups/delete' \
-H 'Authorization: Bearer SECRET_KEY' \
-F 'id="{id}"'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.vendloop.com/user_groups/delete',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('id' => '{id}'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer SECRET_KEY");

var formdata = new FormData();
formdata.append("id", "{id}");

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow'
};

fetch("https://api.vendloop.com/user_groups/delete", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

val client = OkHttpClient()
val mediaType = "text/plain".toMediaType()
val body = MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("id","{id}")
  .build()
val request = Request.Builder()
  .url("https://api.vendloop.com/user_groups/delete")
  .post(body)
  .addHeader("Authorization", "Bearer SECRET_KEY")
  .build()
val response = client.newCall(request).execute()

Sample Response

{
  "status":true,
  "message":"User group deleted"
}

{
  "status": false,
  "message": "User group not found"
}