Getting Started

Authorization

Add parameter in header x-api-key

x-api-key: TheApiKeyValueYouReceivedFromLeadcastSupport

Limit

Use the limit query parameter to set the records per page. Default is 100.

Filter

Parameter: ?filter=

Operators:

eq : equal to

== : equal to

neq : not equal to

!= : not equal to

gt : greater than

> : greater than

lt : lower than

< : lower than

field.Contains("value"): contains part of value

Examples:

Source eq "Headfirst"

Source == "Headfirst

Source neq "Headfirst"

Source != "Headfirst"

Company eq "Orange Cat"

Title.Contains("Specialist")

minimumHourlyRate < 70

minimumHourlyRate > 50

Source eq "Headfirst" and Title.Contains("Specialist")

Company eq "KPN" or Company eq "Orange Cat"

(Company eq "KPN" or Company eq "Orange Cat") and Title.Contains("Specialist")

minimumHourlyRate < 70 and hoursPerWeek > 10

There are more filter options available. More examples will be added later.

Sort

Parameter: ?sort=

Default sort value is CreatedOn desc

Examples:

Title asc

CreatedOn desc, Title asc

Navigating the results

The response will hold (some of) the properties below.

total
the total number of results for the filtered recordset.

items
the individual result items for the active page of the filtered recordset.

_links
contains all the urls you can use to navigate the filtered recordset.

self defines the current url with results

first defines the url with the first page with results

previous defines the url with the previous page with results

next defines the url with the next page with results

last defines the url with the last page with results

{
"_links": {
        "self": "https://localhost/api/public/jobofferslimit=3&filter=title.Contains(%22Specialist%22)&after=a010e5a4-4513-4f8b-b598-aef6ee2f98b8",
        "first": "https://localhost/api/public/jobofferslimit=3&filter=title.Contains(%22Specialist%22)&first=True",
        "previous": "https://localhost/api/public/jobofferslimit=3&filter=title.Contains(%22Specialist%22)&before=92e65ec5-ff87-4ae4-982d-2881bceacdd0",
        "next": "https://localhost/api/public/jobofferslimit=3&filter=title.Contains(%22Specialist%22)&after=4d795810-20b3-4675-9341-8e6d513d1066",
        "last": "https://localhost/api/public/jobofferslimit=3&filter=title.Contains(%22Specialist%22)&last=True"
}
"total": 1839
"items": [
    { .. }
]
}

Authorization#

Limit#

Filter#

Sort#

Navigating the results#

Authorization

Limit

Filter

Sort

Navigating the results