Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
api:api_applicants [2020/10/14 15:06] – [Parameters] Lauri Elevant | api:api_applicants [2020/10/18 11:32] – [HEAD, GET] Lauri Elevant |
---|
List applicants using the filters set as parameters. The number of applicants is represented in the ''X-Count'' header - use the ''HEAD'' request to simply count the number of applicants matching the filters. Use the ''GET'' request to actually fetch them. | List applicants using the filters set as parameters. The number of applicants is represented in the ''X-Count'' header - use the ''HEAD'' request to simply count the number of applicants matching the filters. Use the ''GET'' request to actually fetch them. |
| |
There is a hard limit of 8192 items returned, which is capped to 512 if the ''expand'' parameter is used. | There is a hard limit of 16384 items returned, which is capped to 512 if the ''expand'' parameter is used. |
==== Syntax ==== | ==== Syntax ==== |
| |
| ''byTrackerIDs'' | Optional | List of [[api:api_applicants_trackers|tracker ID-s]] | [1] [2] | | | ''byTrackerIDs'' | Optional | List of [[api:api_applicants_trackers|tracker ID-s]] | [1] [2] | |
| ''byTrackerCodes'' | Optional | List of [[api:api_applicants_trackers|tracker codes]] | [1] [2] | | | ''byTrackerCodes'' | Optional | List of [[api:api_applicants_trackers|tracker codes]] | [1] [2] | |
| ''limit'' | Optional | How many applicants to return (Allowed range is normally 1..8192, 8192 being the default). If the ''expand'' parameter is used, the limit is 512. | | | | ''limit'' | Optional | How many applicants to return (Allowed range is normally 1..16384, 16384 being the default). If the ''expand'' parameter is used, the limit is 512. | | |
| ''expand'' | Optional | Expand the chosen relational element(s), for example ''applicant,offer'' | [3] | | | ''expand'' | Optional | Expand the chosen relational element(s), for example ''applicant,offer'' | [3] | |
| |