v1
latestOpenAPI 3.0.02026-08-061280285.2 KBClient APIs
Lists all client company in the account.
get/api/external/client/list
Query parameters
items_per_pagestring
current_pagestring
include_countstring
Count of total records
Headers
RF-Api-Keystring
Response
Auto generated using Swagger Inspector
{"stackTrail":"paths:/api/external/client/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"added_by":{"email":"admin@recruiterflow.com","id":3264,"name":"System Admin"},"added_time":null,"careers_page":"https://www.ixigo.com/about/careers/","closed_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":91,"job_visibility_id":6,"last_opened":"2020-10-01T05:49:51+0000","locations":[{"city":"Kolkata","country":"India","id":13,"iso_3166_1_alpha_2_code":"IN","name":"Test","postal_code":"700036","state":"West bengal","zipcode":"700036"}],"name":"New Job Pipeline"}],"company_size":3,"company_size_name":"51-200","complete_address":"Golf Course Road, DLF Phase 5, Sector 53, Gurugram, Haryana, India, 122002","contacts":[{"designation":null,"id":154613,"img_link":null,"is_primary":false,"name":"Blah Ixigo"}],"custom_fields":[{"id":43,"name":"Close By","value":"2020-04-16"}],"domain":"gmail.com","files":[],"followers":[],"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/client-company-logos/prod/client/db_b18c893c749e320e66fbb2f7fef6b1be/1/logo.png","industry_id":13,"industry_name":"Internet","lead_owner":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"linkedin_page":"","location":{"city":"Gurugram","country":"India","google_place_id":"ChIJLVyTdrQYDTkRrzz-1CTXg_M","latitude":null,"location":"ixigo, Golf Course Road, Parsvnath Exotica, DLF Phase 5, Sector 53, Gurugram, Haryana, India","longitude":null,"postal_code":"122002","state":"Haryana","street_address_1":"Golf Course Road","street_address_2":"DLF Phase 5, Sector 53"},"name":"Ixigo","notes":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"<div><span class=\"note-user-mention\" data-user-id=\"5059\" data-user-email=\"nareshenoy@outlook.com\">@Naresh Shenoy</span> How are you doing?</div>","created_time":"2021-01-13T19:20:10+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false,"replies":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"<div><span class=\"note-user-mention\" data-user-id=\"3264\" data-user-email=\"admin@recruiterflow.com\">@System Admin</span><span class=\"note-after-user-mention\"> Hi there, edited</span></div>","created_time":"2021-01-13T19:22:32+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false}]}],"open_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":1115,"job_visibility_id":1,"last_opened":"2021-01-04T10:02:18+0000","locations":[{"city":"Bangalore","country":"India","id":1,"iso_3166_1_alpha_2_code":"IN","name":"Bengaluru","postal_code":"560008","state":"Karnataka","zipcode":"560008"}],"name":"Senior Backend Developer"}],"phone_number":[],"pipeline":{"candidates_hired":1,"candidates_submitted":0},"revenue":{"currency":"USD","number":5000000},"status":{"id":null,"name":null},"subsidiary_companies":[],"tags":[]}],"total_items":1}}
Example response
{
"data": [
{
"added_by": {
"email": "admin@recruiterflow.com",
"id": 3264,
"name": "System Admin"
},
"added_time": null,
"careers_page": "https://www.ixigo.com/about/careers/",
"closed_jobs": [
{
"candidates_hired": 0,
"candidates_submitted": 0,
"client_company_contacts": [],
"department_name": "Engineering",
"id": 91,
"job_visibility_id": 6,
"last_opened": "2020-10-01T05:49:51+0000",
"locations": [
{
"city": "Kolkata",
"country": "India",
"id": 13,
"iso_3166_1_alpha_2_code": "IN",
"name": "Test",
"postal_code": "700036",
"state": "West bengal",
"zipcode": "700036"
}
],
"name": "New Job Pipeline"
}
],
"company_size": 3,
"company_size_name": "51-200",
"complete_address": "Golf Course Road, DLF Phase 5, Sector 53, Gurugram, Haryana, India, 122002",
"contacts": [
{
"designation": null,
"id": 154613,
"img_link": null,
"is_primary": false,
"name": "Blah Ixigo"
}
],
"custom_fields": [
{
"id": 43,
"name": "Close By",
"value": "2020-04-16"
}
],
"domain": "gmail.com",
"files": [],
"followers": [],
"id": 1,
"img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/client-company-logos/prod/client/db_b18c893c749e320e66fbb2f7fef6b1be/1/logo.png",
"industry_id": 13,
"industry_name": "Internet",
"lead_owner": {
"email": "admin@recruiterflow.com",
"id": 3264,
"img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png",
"name": "System Admin"
},
"linkedin_page": "",
"location": {
"city": "Gurugram",
"country": "India",
"google_place_id": "ChIJLVyTdrQYDTkRrzz-1CTXg_M",
"latitude": null,
"location": "ixigo, Golf Course Road, Parsvnath Exotica, DLF Phase 5, Sector 53, Gurugram, Haryana, India",
"longitude": null,
"postal_code": "122002",
"state": "Haryana",
"street_address_1": "Golf Course Road",
"street_address_2": "DLF Phase 5, Sector 53"
},
"name": "Ixigo",
"notes": [
{
"author": {
"email": "admin@recruiterflow.com",
"first_name": "System",
"id": 3264,
"img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png",
"last_name": "Admin",
"name": "System Admin"
},
"author_email": "admin@recruiterflow.com",
"author_first_name": "System",
"author_img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png",
"author_last_name": "Admin",
"content": "<div><span class=\"note-user-mention\" data-user-id=\"5059\" data-user-email=\"nareshenoy@outlook.com\">@Naresh Shenoy</span> How are you doing?</div>",
"created_time": "2021-01-13T19:20:10+0000",
"entities": [
{
"id": 154613,
"name": "Blah Ixigo",
"type": 2
},
{
"id": 1,
"name": "Ixigo",
"type": 3
}
],
"is_pinned": false,
"replies": [
{
"author": {
"email": "admin@recruiterflow.com",
"first_name": "System",
"id": 3264,
"img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png",
"last_name": "Admin",
"name": "System Admin"
},
"author_email": "admin@recruiterflow.com",
"author_first_name": "System",
"author_img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png",
"author_last_name": "Admin",
"content": "<div><span class=\"note-user-mention\" data-user-id=\"3264\" data-user-email=\"admin@recruiterflow.com\">@System Admin</span><span class=\"note-after-user-mention\"> Hi there, edited</span></div>",
"created_time": "2021-01-13T19:22:32+0000",
"entities": [
{
"id": 154613,
"name": "Blah Ixigo",
"type": 2
},
{
"id": 1,
"name": "Ixigo",
"type": 3
}
],
"is_pinned": false
}
]
}
],
"open_jobs": [
{
"candidates_hired": 0,
"candidates_submitted": 0,
"client_company_contacts": [],
"department_name": "Engineering",
"id": 1115,
"job_visibility_id": 1,
"last_opened": "2021-01-04T10:02:18+0000",
"locations": [
{
"city": "Bangalore",
"country": "India",
"id": 1,
"iso_3166_1_alpha_2_code": "IN",
"name": "Bengaluru",
"postal_code": "560008",
"state": "Karnataka",
"zipcode": "560008"
}
],
"name": "Senior Backend Developer"
}
],
"phone_number": [],
"pipeline": {
"candidates_hired": 1,
"candidates_submitted": 0
},
"revenue": {
"currency": "USD",
"number": 5000000
},
"status": {
"id": null,
"name": null
},
"subsidiary_companies": [],
"tags": []
}
],
"total_items": 1
}