Get Job Seeker List - Bindbee Docs

GET

api

vms

job-seeker

curl --request GET \
  --url https://api.bindbee.dev/api/vms/v1/job-seeker \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "external_job_seeker_id": "KTY1213456",
      "job_posting_id": "KUNALJP1001",
      "first_name": "Kunal",
      "last_name": "Tyagi",
      "date_available": "2023-11-10T00:00:00Z",
      "supplier_code": "KTSC07",
      "security_id": "KTY12084523",
      "rates": [
        {
          "rate_category": "ST",
          "rate_type": "br",
          "rate_uom": "Hr",
          "value": 21.02
        }
      ],
      "email": "kunal@bindbee.dev",
      "site_code": "KTSC",
      "location_code": "OMLC",
      "worker_pay_type": "AGWTC",
      "submitted_to_other_job_posting": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Query Parameters

remote_id

string

include_raw_data

boolean

default:false

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

Response

200

application/json

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

items.id

string

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

items.custom_fields

object | null

required

The custom fields related to the model

Example:

{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}

items.external_job_seeker_id

string

required

Any unique identifier of this job seeker.

Example:

"KTY1213456"

items.job_posting_id

string

required

The unique identifier for the Job Posting. This identifier must match the external Job Posting identifier for the corresponding data record listed in the Job Posting

Example:

"KUNALJP1001"

items.first_name

string

required

The first name of this job seeker.

Example:

"Kunal"

items.last_name

string

required

The last name of this job seeker.

Example:

"Tyagi"

items.date_available

string

required

The date the job seeker is available to begin working.

Example:

"2023-11-10T00:00:00Z"

items.supplier_code

string

required

The company code of the job seeker’s supplier.

Example:

"KTSC07"

items.security_id

string | null

required

The security ID of the job seeker.

Example:

"KTY12084523"

items.rates

object[]

required

Different rates for the job seeker

Example:

[
  {
    "rate_category": "ST",
    "rate_type": "br",
    "rate_uom": "Hr",
    "value": 21.02
  }
]

items.email

string | null

required

The email address of the job seeker.

Example:

"kunal@bindbee.dev"

items.site_code

string | null

required

Site code for job seeker.

Example:

"KTSC"

items.location_code

string | null

required

Work location code for job seeker.

Example:

"OMLC"

items.worker_pay_type

string | null

required

Work type code for job seeker

Example:

"AGWTC"

items.submitted_to_other_job_posting

boolean | null

required

Indicates whether this specific job seeker is submitted to other job postings

Example:

false

items.raw_data

object | null

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

Create Job Seeker Get Work Order List

curl --request GET \
  --url https://api.bindbee.dev/api/vms/v1/job-seeker \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "external_job_seeker_id": "KTY1213456",
      "job_posting_id": "KUNALJP1001",
      "first_name": "Kunal",
      "last_name": "Tyagi",
      "date_available": "2023-11-10T00:00:00Z",
      "supplier_code": "KTSC07",
      "security_id": "KTY12084523",
      "rates": [
        {
          "rate_category": "ST",
          "rate_type": "br",
          "rate_uom": "Hr",
          "value": 21.02
        }
      ],
      "email": "kunal@bindbee.dev",
      "site_code": "KTSC",
      "location_code": "OMLC",
      "worker_pay_type": "AGWTC",
      "submitted_to_other_job_posting": false
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response