Get Invitations - SG Developers

This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.

For retrieving all invitations of an applicant use the /invitations endpoint directly. The result is presented as a search result. For more details see below. Please note: Only invitations on positions with existing job advertisement will be listed by this endpoint.

By sending the following GET-request, one can obtain the list of an applicants invitations:

curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET
"https://api.softgarden.io/api/rest/v2/frontend/invitations?channel={channelId}"

1 2	curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/invitations?channel={channelId}"

with TOKEN being the user access token of the user in question. It is used to determine the validity of this request. The channelId is the channel where the invitations are looked up.

Path parameters

– none –

Query parameters

Name	Description	Data Type	Default Value
channel	The id of the jobosting channel to be looked up. Can be obtained via /jobboards.	String	n/a

Response values

Upon	Returned value	Description
success	JSON-encoded JobSearchResult-Object	The JobSearchResult helps you to format the result. The ivitations are contained in an a Collection<SearchResult> within the JobSearchResult-object.
failure	500 – INTERNAL SERVER ERROR	When an error appears while processing your request, e.g. the attachmenttId was wrong.
authorization error	401 / 403	See here for details.

Example response value

{
  "itemsPerPage": 1,
  "numPages": 1,
  "offset": 0,
  "actualPage": 1,
  "firstPostingOnPage": 1,
  "lastPostingOnPage": 0,
  "totalNumberOfJobs": 1,
  "results": [
    {
      "jobPostingId": 3207,
      "postingVersionId": 0,
      "title": "Ghostbuster",
      "applyOnlineLink": null,
      "config": {
        "audience": ["00007"],
        "location": ["a9346437c0a8011900bac9798e6a7510"],
        "softgardenvisibility": ["visible"],
        "jobcategory": ["d4d2f9707f0000022fc38d23ef0f1138"]
      },
      "jobStartDate": 1363302000000,
      "postingVersionStartDate": 0,
      "postingVersionEndDate": 0
    }
  ]
}

{

"itemsPerPage": 1,

"numPages": 1,

"offset": 0,

"actualPage": 1,

"firstPostingOnPage": 1,

"lastPostingOnPage": 0,

"totalNumberOfJobs": 1,

"results": [

{

"jobPostingId": 3207,

"postingVersionId": 0,

"title": "Ghostbuster",

"applyOnlineLink": null,

"config": {

"audience": ["00007"],

"location": ["a9346437c0a8011900bac9798e6a7510"],

"softgardenvisibility": ["visible"],

"jobcategory": ["d4d2f9707f0000022fc38d23ef0f1138"]

"jobStartDate": 1363302000000,

"postingVersionStartDate": 0,

"postingVersionEndDate": 0

}

]

}