# SmartRecruiters

> Read recruiting jobs, candidates, applications, offers, hiring teams and configuration; create candidate applications.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/smartrecruiters

## Actions

### Create candidate

Create candidate.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.
- First name (`first_name`, text, required): First name.
- Last name (`last_name`, text, required): Last name.
- Email (`email`, text, required): Email.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "actions": {
      "attachments": {
        "method": "GET",
        "url": "example"
      },
      "consent": {
        "method": "GET",
        "url": "example"
      },
      "consents": {
        "method": "GET",
        "url": "example"
      },
      "properties": {
        "method": "GET",
        "url": "example"
      }
    },
    "averageRating": 0,
    "createdOn": "example",
    "education": [],
    "email": "example",
    "experience": [],
    "firstName": "example",
    "id": "example",
    "internal": false,
    "lastName": "example",
    "location": {
      "city": "example",
      "country": "example",
      "countryCode": "example",
      "lat": 0,
      "lng": 0,
      "region": "example",
      "regionCode": "example"
    },
    "phoneNumber": "example",
    "primaryAssignment": {
      "actions": {
        "sourceDetails": {
          "method": "GET",
          "url": "example"
        }
      },
      "job": {
        "actions": {
          "details": {
            "method": "GET",
            "url": "example"
          },
          "positionDetails": {
            "method": "GET",
            "url": "example"
          }
        },
        "id": "example",
        "title": "example"
      },
      "reasonOfRejection": {
        "id": "example",
        "label": "example"
      },
      "reasonOfWithdrawal": {
        "id": "example",
        "label": "example"
      },
      "source": "example",
      "startsOn": "example",
      "status": "LEAD",
      "subStatus": "example"
    },
    "secondaryAssignments": [],
    "tags": [],
    "updatedOn": "example",
    "web": {
      "facebook": "example",
      "linkedin": "example",
      "skype": "example",
      "twitter": "example",
      "website": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get application

Get application.

**Inputs**

- Candidate ID (`candidate_id`, text, required): Candidate id.
- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "actions": {
      "sourceDetails": {
        "method": "GET",
        "url": "example"
      }
    },
    "applicationId": "example",
    "reasonOfRejection": {
      "id": "example",
      "label": "example"
    },
    "reasonOfWithdrawal": {
      "id": "example",
      "label": "example"
    },
    "source": "example",
    "startsOn": "example",
    "status": "LEAD",
    "subStatus": "example",
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get candidate

Get candidate.

**Inputs**

- Candidate ID (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "actions": {
      "attachments": {
        "method": "GET",
        "url": "example"
      },
      "consent": {
        "method": "GET",
        "url": "example"
      },
      "consents": {
        "method": "GET",
        "url": "example"
      },
      "properties": {
        "method": "GET",
        "url": "example"
      }
    },
    "averageRating": 0,
    "createdOn": "example",
    "education": [],
    "email": "example",
    "experience": [],
    "firstName": "example",
    "id": "example",
    "internal": false,
    "lastName": "example",
    "location": {
      "city": "example",
      "country": "example",
      "countryCode": "example",
      "lat": 0,
      "lng": 0,
      "region": "example",
      "regionCode": "example"
    },
    "phoneNumber": "example",
    "primaryAssignment": {
      "actions": {
        "sourceDetails": {
          "method": "GET",
          "url": "example"
        }
      },
      "job": {
        "actions": {
          "details": {
            "method": "GET",
            "url": "example"
          },
          "positionDetails": {
            "method": "GET",
            "url": "example"
          }
        },
        "id": "example",
        "title": "example"
      },
      "reasonOfRejection": {
        "id": "example",
        "label": "example"
      },
      "reasonOfWithdrawal": {
        "id": "example",
        "label": "example"
      },
      "source": "example",
      "startsOn": "example",
      "status": "LEAD",
      "subStatus": "example"
    },
    "secondaryAssignments": [],
    "tags": [],
    "updatedOn": "example",
    "web": {
      "facebook": "example",
      "linkedin": "example",
      "skype": "example",
      "twitter": "example",
      "website": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get candidate consent

Get candidate consent.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "date": "example",
    "status": "REQUIRED"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get candidate tags

Get candidate tags.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "tags": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get job

Get job.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "actions": {
      "applyOnWeb": {
        "method": "GET",
        "url": "example"
      },
      "details": {
        "method": "GET",
        "url": "example"
      },
      "hiringTeam": {
        "method": "GET",
        "url": "example"
      },
      "positions": {
        "method": "GET",
        "url": "example"
      },
      "publications": {
        "method": "GET",
        "url": "example"
      }
    },
    "compensation": {
      "currency": "example",
      "max": 0,
      "min": 0,
      "period": "HOURLY"
    },
    "createdOn": "example",
    "creator": {
      "firstName": "example",
      "id": "example",
      "lastName": "example"
    },
    "department": {
      "description": "example",
      "id": "example",
      "label": "example"
    },
    "eeoCategory": {
      "id": "example",
      "label": "example"
    },
    "experienceLevel": {
      "id": "example",
      "label": "example"
    },
    "function": {
      "id": "example",
      "label": "example"
    },
    "hiringProcessId": "example",
    "id": "example",
    "industry": {
      "id": "example",
      "label": "example"
    },
    "jobAd": {
      "language": {
        "code": "example",
        "label": "example",
        "labelNative": "example"
      },
      "sections": {
        "additionalInformation": {
          "text": "example",
          "title": "example"
        },
        "companyDescription": {
          "text": "example",
          "title": "example"
        },
        "jobDescription": {
          "text": "example",
          "title": "example"
        },
        "qualifications": {
          "text": "example",
          "title": "example"
        },
        "videos": {
          "urls": []
        }
      }
    },
    "lastActivityOn": "example",
    "location": {
      "address": "example",
      "city": "example",
      "country": "example",
      "countryCode": "example",
      "hybrid": false,
      "hybridDescription": "example",
      "latitude": "example",
      "longitude": "example",
      "manual": false,
      "postalCode": "example",
      "region": "example",
      "regionCode": "example",
      "remote": false
    },
    "postingStatus": "PUBLIC",
    "properties": [],
    "refNumber": "example",
    "status": "CREATED",
    "targetHiringDate": "example",
    "template": false,
    "title": "example",
    "typeOfEmployment": {
      "id": "example",
      "label": "example"
    },
    "updatedOn": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get user

Get user.

**Inputs**

- Person ID (`person_id`, text, required): Person id.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "accessGroups": [],
    "active": false,
    "email": "example",
    "externalData": "example",
    "firstName": "example",
    "id": "example",
    "language": {
      "code": "bg"
    },
    "lastName": "example",
    "location": {
      "address": "example",
      "city": "example",
      "country": "example",
      "countryCode": "example",
      "latitude": "example",
      "longitude": "example",
      "postalCode": "example",
      "region": "example",
      "regionCode": "example"
    },
    "personIdExternal": "example",
    "ssoIdentifier": "example",
    "ssoLoginMode": "SSO",
    "systemRole": {
      "id": "example",
      "name": "example"
    },
    "updatedOn": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List candidate attachments

List candidate attachments.

**Inputs**

- Candidate ID (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List candidate properties

List candidate properties.

**Inputs**: None.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List candidates

List candidates. Returns one page; use next_cursor to continue.

**Inputs**

- Results per page (`limit`, number): Maximum records in this page. Leave empty for the service default. From 1 to 100.
- Search (`q`, text): Words to find in the service.
- Next page cursor (`page_id`, text): Leave empty for the first page; use next_cursor from the previous result to continue.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "limit": 0,
    "nextPageId": "example",
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List departments

List departments.

**Inputs**: None.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job ads

List job ads.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (list): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List job hiring team

List job hiring team.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job positions

List job positions.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "positionsPendingApproval": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job properties

List job properties.

**Inputs**: None.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job publications

List job publications.

**Inputs**

- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List jobs

List jobs. Returns one page; use next_cursor to continue.

**Inputs**

- Results per page (`limit`, number): Maximum records in this page. Leave empty for the service default. From 1 to 100.
- Next page cursor (`page_id`, text): Leave empty for the first page; use next_cursor from the previous result to continue.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "limit": 0,
    "nextPageId": "example",
    "offset": 0,
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List offers

List offers.

**Inputs**

- Candidate ID (`candidate_id`, text, required): Candidate id.
- Job (`job_id`, text, required): Choose the job or use an ID from a previous step.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "limit": 0,
    "offset": 0,
    "totalFound": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List users

List users.

**Inputs**: None.

**Outputs**

- `data` (object): The service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor to request the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "content": [],
    "limit": 0,
    "nextPageId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
