Skip to content

HTO-2357: Update API version in Openings documentation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
edgar-pe wants to merge 1 commit into
base: api_doc
Choose a base branch
from
Draft

HTO-2357: Update API version in Openings documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions source/includes/openings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ close_date | <strong>integer</strong>


```shell
curl https://api.recruiterbox.com/v1/openings \
curl https://api.recruiterbox.com/api/v2/openings \
Copy link
Member

@vedarthk vedarthk Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have URL rewrite rule for api.{domain}{url} -> api.{domain}/public_api{url} setup in our Nginx, eg:

https://api.recruiterbox.com/v1/openings gets re-written to : https://api.recruiterbox.com/api/v2/openings

The documentation is correct.

-u {api_key}:
```
> The above command returns JSON structured like this:
Expand Down Expand Up @@ -74,7 +74,7 @@ This endpoint retrieves all openings.

### HTTP Request

`GET https://api.recruiterbox.com/v1/openings/`
`GET https://api.recruiterbox.com/api/v2/openings/`

### Query Parameters

Expand All @@ -101,7 +101,7 @@ team | Filter by team


```shell
curl https://api.recruiterbox.com/v1/openings/a42f3 \
curl https://api.recruiterbox.com/api/v2/openings/a42f3 \
-u {api_key}:
```
> The above command returns JSON structured like this:
Expand Down Expand Up @@ -134,7 +134,7 @@ This endpoint retrieves a specific opening.

### HTTP Request

`GET https://api.recruiterbox.com/v1/openings/{id}`
`GET https://api.recruiterbox.com/api/v2/openings/{id}`

### URL Parameters

Expand All @@ -148,7 +148,7 @@ id | ID of the opening to retrieve


```shell
curl https://api.recruiterbox.com/v1/openings/a42f3/application_form \
curl https://api.recruiterbox.com/api/v2/openings/a42f3/application_form \
-u {api_key}:
```
> The above command returns JSON structured like this:
Expand Down Expand Up @@ -228,7 +228,7 @@ This endpoint retrieves all application form fields of a specific opening.

### HTTP Request

`GET https://api.recruiterbox.com/v1/openings/{id}/application_form`
`GET https://api.recruiterbox.com/api/v2/openings/{id}/application_form`

### Attributes

Expand Down Expand Up @@ -278,7 +278,7 @@ curl -H "Content-Type: application/json" -X POST -d '{
}
],
"source" : "new website"
}' https://api.recruiterbox.com/v1/openings/a42f3/apply -u {api_key}:
}' https://api.recruiterbox.com/api/v2/openings/a42f3/apply -u {api_key}:
```
> The above command returns empty response on success with a status code 201.

Expand All @@ -287,7 +287,7 @@ This endpoint lets you apply to an opening. The end result is a candidate assign

### HTTP Request

`POST https://api.recruiterbox.com/v1/openings/{id}/apply`
`POST https://api.recruiterbox.com/api/v2/openings/{id}/apply`

### URL Parameters

Expand Down Expand Up @@ -331,7 +331,7 @@ curl -H "Content-Type: application/json" -X POST -d '{
}
],
"source" : "new website"
}' https://api.recruiterbox.com/v1/openings/a42f3/apply -u {api_key}:
}' https://api.recruiterbox.com/api/v2/openings/a42f3/apply -u {api_key}:
```

> The above command returns JSON structured like this: (response for bad request with status code 400)
Expand Down