| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:api_applicants [2020/08/06 15:05] – [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 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..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] | |
| |
| * // Note [1]: Lists can be either comma or space separated. All list items are combined with logical ''OR'' operators - in other words an application is considered matching if it matches to any of the values in the list.// | * // Note [1]: Lists can be either comma or space separated. All list items are combined with logical ''OR'' operators - in other words an application is considered matching if it matches to any of the values in the list.// |
| * //Note [2]: you may use either tracker ID-s or codes to reference trackers. However ID-s are guaranteed not to change while the tracker codes offer no such guarantee. // | * // Note [2]: you may use either tracker ID-s or codes to reference trackers. However ID-s are guaranteed not to change while the tracker codes offer no such guarantee. // |
| | * // Note [3]: Some elements in the returned objects are links to other API calls. Using the ''expand'' parameter, it is possible to expand this data to the actual records, saving additional API calls. The full list of possible expansions is ''trackers,documents,consents,invoices,wishes''. You can set one or multiple expansions, combining them in a comma-separated fashion to the ''expand'' parameter. Note also that using this parameter caps to ''limit'' to 512 due to performance reasons.// |
| |
| ==== Response headers ==== | ==== Response headers ==== |