Introduction

Welcome to the RecruitVirtual Connect API! You can use our API to access RecruitVirtual Connect API endpoints, which can get information on your events, registrations and resumes.

We have language bindings in Shell! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

API uses "Authorization" http headers.

# With shell, you can just pass the correct header with each request
curl "https://app.recruitvirtual.com/connect/api/events.json" -H "Authorization: Bearer token=811848c383bf8e76b8d7c8854b5dbc5b"

Make sure to replace 811848c383bf8e76b8d7c8854b5dbc5b with your API key.

RecruitVirtual Connect uses API keys to allow access to the API. Your representative can provide you with an API key.

RecruitVirtual Connect expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer token=811848c383bf8e76b8d7c8854b5dbc5b

Events

Get events

curl "https://app.recruitvirtual.com/connect/api/events.json"
  -H "Authorization: Bearer token=811848c383bf8e76b8d7c8854b5dbc5b"

The above command returns JSON structured like this:

{
  "results": [
    {
        "id": "major-hiring-event-2020-05-27",
        "title": "Test",
        "date": "2020-05-27",
        "start_time": "2020-05-27T14:00:00.000Z",
        "end_time": "2020-05-27T22:00:00.000Z",
        "url": "https://app.recruitvirtual.com/events/major-hiring-event-2020-05-27",
        "registrations_count": 0,
        "registrations": "https://app.recruitvirtual.comconnect/api/events/major-hiring-event-2020-05-27/registrations.json"
    },
    {
    ...
    }
  ],
  "next_page": "https://app.recruitvirtual.com/connect/api/events?page=2",
  "current_page": 1,
  "total_pages": 72
}

This endpoint retrieves all events, paginated.

HTTP Request

GET https://app.recruitvirtual.com/connect/api/events?page=2

Query Parameters

Get event registrations

We recommend to follow links provided for every event. For example

"registrations": "https://app.recruitvirtual.com/connect/api/events/major-hiring-event-2020-05-27/registrations.json"

curl "https://app.recruitvirtual.com/connect/api/events/[event-id]/registrations.json"
  -H "Authorization: Bearer token=811848c383bf8e76b8d7c8854b5dbc5b"

The above command returns JSON structured like this:

{
  "results": [
    {
      "id": 56,
      "first_name": "John",
      "last_name": "Doe",
      "email": "admin@recruitvirtual.com",
      "phone": "5554609421",
      "resume": "https://jobfairs.nyc3.digitaloceanspaces.com/development/jobseeker/resume/69/Resume.pdf?AWSAccessKeyId=XBFSGPGPTZFVRNYIYS36&Signature=sQ6iMxz%2F3lWKT7R%2F8ejDeaqGepk%3D&Expires=1591147757"
    },
    {
    ...
    }
  ],
  "current_page": 1,
  "total_pages": 1
}

Errors

The API uses the following error codes: