Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| api:api_applicants [2020/10/18 11:34] – [Parameters] Lauri Elevant | api:api_applicants [2023/02/06 13:14] – [HEAD, GET] Safak Samiloglu |
|---|
| 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. | There is a hard limit of 32768 items returned, which is capped to 8192 if the ''expand'' parameter is used. |
| ==== Syntax ==== | ==== Syntax ==== |
| |
| ^ Name ^ ^ Description ^ Notes ^ | ^ Name ^ ^ Description ^ Notes ^ |
| | ''bySince'' | Optional | An ISO datetime or the (sequential) ID from which you want to start fetching from (inclusive) | [4] | | | ''bySince'' | Optional | An ISO datetime or the (sequential) ID from which you want to start fetching from (inclusive) | [4] | |
| | | ''byUntil'' | Optional | An ISO datetime or the (sequential) ID up to which to fetch to (inclusive) | [4] | |
| | ''byCitizenships'' | Optional | List of [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country codes]] | [1] | | | ''byCitizenships'' | Optional | List of [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country codes]] | [1] | |
| | ''byEmails'' | Optional | List of emails | [1] | | | ''byEmails'' | Optional | List of emails | [1] | |