HireStack API

Overview

Endpoints

candidate

job

Schemas

CandidateInterviewResponse

CandidateInterviewResponseRating

CandidateInterviewResponseComment

Video

MutationStatus

CandidateInterview

string<uuid>

required

candidate

object

string<uuid>

required

name

string

icon

string

workspace

object

jobsCount

number<integer>

user

object

createdAt

string<date-time>

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

overage

boolean

createdAt

string<date-time>

status

string

Allowed values:

pendingcomplete

Example

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