Namirasoft Job Arranger API V1
Namira Software Corporation Job Arranger API Version 1 (1.4.55)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-job-arranger-api-v1
Commands
Healthz
Get
Returns the application health status
ns-job-arranger healthz get
Value
List
Returns the value list of a given table and column
ns-job-arranger value list {table} {column} {search} {field_id} {limit}
Company
List
Returns the company list
ns-job-arranger company list
GetDashboard
Returns a dashboard company
ns-job-arranger company getdashboard {company}
JobCategory
List
Returns the job category list
ns-job-arranger jobcategory list {filters} {page} {size} {sorts}
Get
Returns a job category by id.
ns-job-arranger jobcategory get {id}
Create
Creates a new job category for an entity
ns-job-arranger jobcategory create {entity_id}
--category_id (String)
Delete
Deletes a job category by an id.
ns-job-arranger jobcategory delete {entity_id} {id}
JobField
List
Returns the job field list
ns-job-arranger jobfield list {filters} {page} {size} {sorts}
Get
Returns a job field by id.
ns-job-arranger jobfield get {id}
Create
Creates a new job field for an entity
ns-job-arranger jobfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a job field by an id for an entity
ns-job-arranger jobfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a job field by an id.
ns-job-arranger jobfield delete {entity_id} {id}
JobTag
List
Returns the job tag list
ns-job-arranger jobtag list {filters} {page} {size} {sorts}
Get
Returns a job tag by id.
ns-job-arranger jobtag get {id}
Create
Creates a new job tag for an entity
ns-job-arranger jobtag create {entity_id}
--name (String)
--value (String)
Update
Updates a job tag by an id for an entity
ns-job-arranger jobtag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a job tag by an id.
ns-job-arranger jobtag delete {entity_id} {id}
Job
List
Returns the job list
ns-job-arranger job list {filters} {page} {size} {sorts}
Get
Returns a job by an id
ns-job-arranger job get {id}
Set
Sets a job by an id or sid
ns-job-arranger job set {id_sid}
--sid (String)
--workspace_id (String)
--reason_id (String)
--platform (Enum)
--url (String)
--name (String)
--company (String)
--location (String)
--remote (String)
--min (String)
--max (String)
--status (Enum)
--job_category (Array)
--job_field (Array)
--job_tag (Array)
Delete
Deletes a job by an id
ns-job-arranger job delete {id}
Location
List
Returns the location list
ns-job-arranger location list {filters} {page} {size} {sorts}
ReasonCategory
List
Returns the reason category list
ns-job-arranger reasoncategory list {filters} {page} {size} {sorts}
Get
Returns a reason category by id.
ns-job-arranger reasoncategory get {id}
Create
Creates a new reason category for an entity
ns-job-arranger reasoncategory create {entity_id}
--category_id (String)
Delete
Deletes a reason category by an id.
ns-job-arranger reasoncategory delete {entity_id} {id}
ReasonField
List
Returns the reason field list
ns-job-arranger reasonfield list {filters} {page} {size} {sorts}
Get
Returns a reason field by id.
ns-job-arranger reasonfield get {id}
Create
Creates a new reason field for an entity
ns-job-arranger reasonfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a reason field by an id for an entity
ns-job-arranger reasonfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a reason field by an id.
ns-job-arranger reasonfield delete {entity_id} {id}
ReasonTag
List
Returns the reason tag list
ns-job-arranger reasontag list {filters} {page} {size} {sorts}
Get
Returns a reason tag by id.
ns-job-arranger reasontag get {id}
Create
Creates a new reason tag for an entity
ns-job-arranger reasontag create {entity_id}
--name (String)
--value (String)
Update
Updates a reason tag by an id for an entity
ns-job-arranger reasontag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a reason tag by an id.
ns-job-arranger reasontag delete {entity_id} {id}
Reason
List
Returns the reason list
ns-job-arranger reason list {filters} {page} {size} {sorts}
Get
Returns a reason by an id
ns-job-arranger reason get {id}
Create
Creates a new reason
ns-job-arranger reason create
--workspace_id (String)
--name (String)
--status (Enum)
--reason_category (Array)
--reason_field (Array)
--reason_tag (Array)
Update
Updates a reason by an id
ns-job-arranger reason update {id}
--workspace_id (String)
--name (String)
--status (Enum)
--reason_category (Array)
--reason_field (Array)
--reason_tag (Array)
Delete
Deletes a reason by an id
ns-job-arranger reason delete {id}
Remote
List
Returns the remote list
ns-job-arranger remote list {filters} {page} {size} {sorts}
User
Dashboard
Gets user dashboard
ns-job-arranger user dashboard
GetCredit
Returns the current user's credit
ns-job-arranger user getcredit
Error
Create
Creates a new error
ns-job-arranger error create
--message (String)
ExtensionChromeSetting
Get
Returns the setting of chrome extension
ns-job-arranger extensionchromesetting get
Schemas
Dashboard
{ "name": "Dashboard", "type": "Object", "required": true, "fields": { "byStatus": { "type": "Array", "required": true, "items": [ { "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] }, "byPlatform": { "type": "Array", "required": true, "items": [ { "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] }, "jobs": { "type": "Array", "required": true, "items": [ { "name": "Job", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sid": { "type": "String", "required": true, "max": 255 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "platform": { "name": "JobPlatform", "type": "Enum", "required": true, "valids": [ "LinkedIn", "Indeed", "Glassdoor", "Monster", "JobBank", "CareerBuilder" ] }, "url": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "company": { "type": "String", "required": true, "max": 255 }, "location": { "type": "String", "required": true, "max": 255 }, "remote": { "type": "String", "required": false, "max": 255 }, "min": { "type": "String", "required": false, "max": 255 }, "max": { "type": "String", "required": false, "max": 255 }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
DashboardItem
{ "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } }}
Job
{ "name": "Job", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sid": { "type": "String", "required": true, "max": 255 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "platform": { "name": "JobPlatform", "type": "Enum", "required": true, "valids": [ "LinkedIn", "Indeed", "Glassdoor", "Monster", "JobBank", "CareerBuilder" ] }, "url": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "company": { "type": "String", "required": true, "max": 255 }, "location": { "type": "String", "required": true, "max": 255 }, "remote": { "type": "String", "required": false, "max": 255 }, "min": { "type": "String", "required": false, "max": 255 }, "max": { "type": "String", "required": false, "max": 255 }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
JobCategory
{ "name": "JobCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
JobField
{ "name": "JobField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
JobTag
{ "name": "JobTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
JobFull
{ "name": "JobFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sid": { "type": "String", "required": true, "max": 255 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "platform": { "name": "JobPlatform", "type": "Enum", "required": true, "valids": [ "LinkedIn", "Indeed", "Glassdoor", "Monster", "JobBank", "CareerBuilder" ] }, "url": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "company": { "type": "String", "required": true, "max": 255 }, "location": { "type": "String", "required": true, "max": 255 }, "remote": { "type": "String", "required": false, "max": 255 }, "min": { "type": "String", "required": false, "max": 255 }, "max": { "type": "String", "required": false, "max": 255 }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "job_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "job_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "job_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
JobInput
{ "name": "JobInput", "type": "Object", "required": true, "fields": { "sid": { "type": "String", "required": true, "max": 255 }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "platform": { "name": "JobPlatform", "type": "Enum", "required": true, "valids": [ "LinkedIn", "Indeed", "Glassdoor", "Monster", "JobBank", "CareerBuilder" ] }, "url": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "company": { "type": "String", "required": true, "max": 255 }, "location": { "type": "String", "required": true, "max": 255 }, "remote": { "type": "String", "required": false, "max": 255 }, "min": { "type": "String", "required": false, "max": 255 }, "max": { "type": "String", "required": false, "max": 255 }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "job_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "job_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "job_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
ReasonCategory
{ "name": "ReasonCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ReasonField
{ "name": "ReasonField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ReasonTag
{ "name": "ReasonTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Reason
{ "name": "Reason", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "status": { "name": "ReasonStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ReasonFull
{ "name": "ReasonFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "status": { "name": "ReasonStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "reason_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "reason_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "reason_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
ReasonInput
{ "name": "ReasonInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "status": { "name": "ReasonStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "reason_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "reason_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "reason_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Credit
{ "name": "Credit", "type": "Object", "required": true, "fields": { "valid_to": { "type": "String", "required": false }, "delay": { "type": "Integer", "required": true }, "delay_remained": { "type": "Integer", "required": true } }}
Enums
JobPlatform
Indeed
Glassdoor
Monster
JobBank
CareerBuilder
JobStatus
BlackList
WhiteList
Emailed
Applied
Replied
Interviewed
Rejected
Hired
ReasonStatus
BlackList
WhiteList
Emailed
Applied
Replied
Interviewed
Rejected
Hired
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.