Returns an (optionally) filtered list of all candidates in an account accessible to the authenticated user.
curl -X GET\
\
-H "Accept: application/json"\
"https://rest.enablehr.com/accounts/{accountId}/candidates?filter=&sort=&first=&after=&last=&before="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;
import java.io.File;
import java.util.*;
public class CandidatesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Create an instance of the API class
CandidatesApi apiInstance = new CandidatesApi();
String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
Integer first = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
String after = 342dfs09ds329320; // String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
Integer last = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
String before = 531dfs09ds332932; // String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
try {
CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CandidatesApi#listCandidates");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.CandidatesApi;
public class CandidatesApiExample {
public static void main(String[] args) {
CandidatesApi apiInstance = new CandidatesApi();
String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
Integer first = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
String after = 342dfs09ds329320; // String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
Integer last = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
String before = 531dfs09ds332932; // String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
try {
CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CandidatesApi#listCandidates");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *filter = name:Scottie*; // A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
(optional) (default to null)
array[String] *sort = sort=name:asc&sort=type:desc; // WIP Description
Specify the field, followed by asc/desc, separated by :
(optional) (default to null)
Integer *first = 100; // WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
String *after = 342dfs09ds329320; // WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
Integer *last = 100; // WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
String *before = 531dfs09ds332932; // WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
// Lists candidates
[apiInstance listCandidatesWith:accountId
filter:filter
sort:sort
first:first
after:after
last:last
before:before
completionHandler: ^(CandidatesPage output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var opts = {
'filter': name:Scottie*, // {String} A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
'sort': sort=name:asc&sort=type:desc, // {array[String]} WIP Description
Specify the field, followed by asc/desc, separated by :
'first': 100, // {Integer} WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
'after': 342dfs09ds329320, // {String} WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
'last': 100, // {Integer} WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
'before': 531dfs09ds332932 // {String} WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.listCandidates(accountId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class listCandidatesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: OAuth2
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
var apiInstance = new CandidatesApi();
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account. (default to null)
var filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
(optional) (default to null)
var sort = new array[String](); // array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
(optional) (default to null)
var first = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
var after = 342dfs09ds329320; // String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
var last = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
var before = 531dfs09ds332932; // String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
try {
// Lists candidates
CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling CandidatesApi.listCandidates: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
$sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
$first = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
$after = 342dfs09ds329320; // String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
$last = 100; // Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
$before = 531dfs09ds332932; // String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
try {
$result = $api_instance->listCandidates($accountId, $filter, $sort, $first, $after, $last, $before);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CandidatesApi->listCandidates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;
# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $filter = name:Scottie*; # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
my $sort = [sort=name:asc&sort=type:desc]; # array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
my $first = 100; # Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
my $after = 342dfs09ds329320; # String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
my $last = 100; # Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
my $before = 531dfs09ds332932; # String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
eval {
my $result = $api_instance->listCandidates(accountId => $accountId, filter => $filter, sort => $sort, first => $first, after => $after, last => $last, before => $before);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CandidatesApi->listCandidates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
filter = name:Scottie* # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.
An asterix (`*`) can also be used as a wildcard for partial matches on words.
Logical operators (`AND` and `OR`) can be used between terms.
Terms can be grouped via parenthesis to build complex search queries (see examples below).
The fields used in the field must be fields returned from the REST API endpoint.
Some example filters:
* `firstName:John` which would return employees whose firstName was John.
* `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
* `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
* `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
* `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
* `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
* Date filter:
* Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]`
* Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}`
* Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
(optional) (default to null)
sort = sort=name:asc&sort=type:desc # array[String] | WIP Description
Specify the field, followed by asc/desc, separated by :
(optional) (default to null)
first = 100 # Integer | WIP Description
Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
after = 342dfs09ds329320 # String | WIP Description
Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
last = 100 # Integer | WIP Description
Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
before = 531dfs09ds332932 # String | WIP Description
Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
(optional) (default to null)
try:
# Lists candidates
api_response = api_instance.list_candidates(accountId, filter=filter, sort=sort, first=first, after=after, last=last, before=before)
pprint(api_response)
except ApiException as e:
print("Exception when calling CandidatesApi->listCandidates: %s\n" % e)
extern crate CandidatesApi;
pub fn main() {
let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
let filter = name:Scottie*; // String
let sort = sort=name:asc&sort=type:desc; // array[String]
let first = 100; // Integer
let after = 342dfs09ds329320; // String
let last = 100; // Integer
let before = 531dfs09ds332932; // String
let mut context = CandidatesApi::Context::default();
let result = client.listCandidates(accountId, filter, sort, first, after, last, before, &context).wait();
println!("{:?}", result);
}