HireStack API

Overview

Endpoints

candidate

job

Schemas

CandidateInterviewResponse

CandidateInterviewResponseRating

CandidateInterviewResponseComment

Video

MutationStatus

JobCandidate

string<uuid>

required

job

object

string<uuid>

required

ID of the job

title

string

Job title that candidates will apply to

category

string

experience

number<integer>

status

string

Status of the job, determines whether a candidates can apply for the job and whether it is counted for billing purposes

Allowed values:

draftactiveinactivedeleted

createdAt

string<date-time>

Timestamp for when the job was created

createdBy

object

workspace

object

candidatesCount

number<integer>

Number of candidates that have applied for this job

status

string

Allowed values:

invitedappliedshortlisthired

candidate

object

string<uuid>

required

name

string

icon

string

workspace

object

jobsCount

number<integer>

user

object

createdAt

string<date-time>

experience

number<integer>

rating

number<float>

sort

number<integer>

createdAt

string<date-time>

Example

1
{
2
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3
  "job": {
4
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
5
    "title": "string",
6
    "category": "string",
7
    "experience": 0,
8
    "status": "draft",
9
    "createdAt": "2019-08-24T14:15:22Z",
10
    "createdBy": {
11
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
12
      "name": "string",
13
      "icon": "string",
14
      "role": 0,
15
      "workspace": {
16
        "me": {}
17
      },
18
      "user": {}
19
    },
20
    "workspace": {
21
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
22
      "slug": "string",
23
      "icon": "string",
24
      "name": "string",
25
      "billing": "string",
26
      "plan": "string",
27
      "role": 0,
28
      "me": {
29
        "workspace": {},
30
        "user": {}
31
      },
32
      "createdAt": "2019-08-24T14:15:22Z",
33
      "updatedAt": "2019-08-24T14:15:22Z",
34
      "usersCount": 0,
35
      "jobsCount": 0,
36
      "candidatesCount": 0
37
    },
38
    "candidatesCount": 0
39
  },
40
  "status": "invited",
41
  "candidate": {
42
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
43
    "name": "string",
44
    "icon": "string",
45
    "workspace": {
46
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
47
      "slug": "string",
48
      "icon": "string",
49
      "name": "string",
50
      "billing": "string",
51
      "plan": "string",
52
      "role": 0,
53
      "me": {
54
        "workspace": {},
55
        "user": {}
56
      },
57
      "createdAt": "2019-08-24T14:15:22Z",
58
      "updatedAt": "2019-08-24T14:15:22Z",
59
      "usersCount": 0,
60
      "jobsCount": 0,
61
      "candidatesCount": 0
62
    },
63
    "jobsCount": 0,
64
    "user": {
65
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
66
      "name": "string",
67
      "email": "string",
68
      "verified": true,
69
      "icon": "string"
70
    },
71
    "createdAt": "2019-08-24T14:15:22Z"
72
  },
73
  "experience": 0,
74
  "rating": 0,
75
  "sort": 0,
76
  "createdAt": "2019-08-24T14:15:22Z"
77
}