Get All designations.

1min
GET
https://{domain}/app/api/v2/users/designation
Get all designations. Designation is basically a collection of groups.
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-REQUEST-ID
string
*
Responses
200
Get User Response
object
data
DesignationSchema[]
request
Request
error
Error
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/api/v2/users/designation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/api/v2/users/designation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
default
// Get User Response 
{
  "data": [
    {
      "tenantId": "os1devs",
      "userOwnerType": "os1devs",
      "function": "operations",
      "designationName": "Field Executive",
      "description": "On ground employees who are working to pickup/drop the orders",
      "groupIds": [
        ""
      ]
    }
  ],
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  }
}
// Get User Response 
{
  "data": [
    {
      "tenantId": "os1devs",
      "userOwnerType": "os1devs",
      "function": "operations",
      "designationName": "Field Executive",
      "description": "On ground employees who are working to pickup/drop the orders",
      "groupIds": [
        ""
      ]
    }
  ],
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  }
}
﻿
﻿
Updated 15 Mar 2024
Did this page help you?
Create a designation.
Create a Group.