<details open="true"><summary>List/Search Applicant</summary><div data-lexical-collapsible-content="true"> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/search</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 } }</pre></div></details> <details open="true"><summary>Get an Applicant</summary><div data-lexical-collapsible-content="true"> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/{applicantId}</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } } }</pre></div></details> <details open="true"><summary>Promote Applicant to Next Stage</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/promote</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "stage":3 // pipeline stage id [Integer] }</pre> Get the stage id using <code>/jobs/{jobId}/stages</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details> <details open="true"><summary>Rate Applicant with Status</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/update-status</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "status": "good_fit" // [String] }</pre>Must be from any of this: <code>good_fit</code>, <code>maybe</code>, <code>not_a_fit</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre></div></details>

Get all applicants applied to your published job

<details><summary>List/Search Applicant</summary>

```
GET /applicants/{jobId}/search
```

****Response****

```
{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&color=7F9CF5&background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 }}
```</details><details><summary>Get an Applicant</summary>

```
GET /applicants/{jobId}/{applicantId}
```

****Response****

```
{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&color=7F9CF5&background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }}
```</details><details><summary>Promote Applicant to Next Stage</summary>

```
POST /applicants/{jobId}/{applicantId}/promote
```

****Body****

```
{ "stage":3 // pipeline stage id [Integer]}
```

Get the stage id using`/jobs/{jobId}/stages`

****Response****

```
{ "success": "success"}
```</details><details><summary>Rate Applicant with Status</summary>

```
POST /applicants/{jobId}/{applicantId}/update-status
```

****Body****

```
{ "status": "good_fit" // [String]}
```

Must be from any of this:**`**good\_fit**`**,**`**maybe**`**,**`**not\_a\_fit**`**

****Response****

```
{ "success": "success"}
```</details>

Applicants

<h1 class="PlaygroundEditorTheme__h1" dir="ltr">List / Search Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/search</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 } }</pre> <h1 class="PlaygroundEditorTheme__h1" dir="ltr">Get an Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/{applicantId}</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } } }</pre> <details open="true"><summary>Promote Applicant to Next Stage</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/promote</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "stage":3 // pipeline stage id [Integer] }</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details>

<h1 class="PlaygroundEditorTheme__h1" dir="ltr">List / Search Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/search</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 } }</pre> <h1 class="PlaygroundEditorTheme__h1" dir="ltr">Get an Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/{applicantId}</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } } }</pre> <details open="true"><summary>Promote Applicant to Next Stage</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/promote</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "stage":3 // pipeline stage id [Integer] }</pre> Get the stage id using <code>/jobs/{jobId}/stages</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details>

<h1 class="PlaygroundEditorTheme__h1" dir="ltr">List / Search Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/search</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 } }</pre> <h1 class="PlaygroundEditorTheme__h1" dir="ltr">Get an Applicant</h1> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/{applicantId}</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } } }</pre> <details open="true"><summary>Promote Applicant to Next Stage</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/promote</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "stage":3 // pipeline stage id [Integer] }</pre> Get the stage id using <code>/jobs/{jobId}/stages</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details><details open="true"><summary>Rate Applicant with Status</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/update-status</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "status": "good_fit" // [String] }</pre>Must be from any of this: <code>good_fit</code>, <code>maybe</code>, <code>not_a_fit</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details>

<h1 class="PlaygroundEditorTheme__h1" dir="ltr">List / Search Applicant</h1> <details open="true"><summary>List/Search Applicant</summary><div data-lexical-collapsible-content="true"> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/search</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": [ { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } }, ... ], "meta": { "current_page": 1, "from": 1, "last_page": 1, "per_page": 15, "to": 8, "total": 8 } }</pre></div></details> <details open="true"><summary>Get an Applicant</summary><div data-lexical-collapsible-content="true"> <pre spellcheck="false" data-highlight-language="javascript">GET /applicants/{jobId}/{applicantId}</pre> Response<pre spellcheck="false" data-highlight-language="javascript">{ "data": { "id": 4, "name": "Liam Bernhard", "email": "benedict62@example.com", "phone": "+1-480-480-4061", "applied": "54 minutes ago", "stage": "Applied", "status": "Good Fit", "image": "https://ui-avatars.com/api/?name=L+B&amp;color=7F9CF5&amp;background=EBF4FF", "job": { "title": "Legal Secretary", "type": "part time", "workspace_type": "remote", "deadline": "2024-02-29T18:00:00.000000Z" } } }</pre></div></details> <details open="true"><summary>Promote Applicant to Next Stage</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/promote</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "stage":3 // pipeline stage id [Integer] }</pre> Get the stage id using <code>/jobs/{jobId}/stages</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details><details open="true"><summary>Rate Applicant with Status</summary><div data-lexical-collapsible-content="true"><pre spellcheck="false" data-highlight-language="javascript">POST /applicants/{jobId}/{applicantId}/update-status</pre> Body<pre spellcheck="false" data-highlight-language="javascript">{ "status": "good_fit" // [String] }</pre>Must be from any of this: <code>good_fit</code>, <code>maybe</code>, <code>not_a_fit</code> Response<pre spellcheck="false" data-highlight-language="javascript">{ "success": "success" }</pre> </div></details>

Was this article helpful?