v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
User APIs

The Users endpoint allows you to export all user related information from Recruiterflow.

get/api/external/user/list

Query parameters

include_countstring

Count of total records

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/user/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"email":"manish.kotian36@outlook.com","first_name":"Manish","id":40201,"img_link":null,"last_name":"Kotian","middle_name":"","name":"Manish Kotian","roles":[{"id":1,"name":"Admin"}]},{"email":"manish+1@recruiterflow.com","first_name":"Manish","id":40626,"img_link":null,"last_name":"Kotian","middle_name":"","name":"Manish Kotian","roles":[{"id":7,"name":"Contact"}]}],"total_items":2}}

Example response

{
  "data": [
    {
      "email": "manish.kotian36@outlook.com",
      "first_name": "Manish",
      "id": 40201,
      "img_link": null,
      "last_name": "Kotian",
      "middle_name": "",
      "name": "Manish Kotian",
      "roles": [
        {
          "id": 1,
          "name": "Admin"
        }
      ]
    },
    {
      "email": "manish+1@recruiterflow.com",
      "first_name": "Manish",
      "id": 40626,
      "img_link": null,
      "last_name": "Kotian",
      "middle_name": "",
      "name": "Manish Kotian",
      "roles": [
        {
          "id": 7,
          "name": "Contact"
        }
      ]
    }
  ],
  "total_items": 2
}