Get job scans for account
Try it
See Job scan properties for a detailed description of the json elements below.
Request parameters
You can specify the following query parameters to filter the account's job scans.
Name | Description | Default value |
---|---|---|
accountId | A valid accountId must be provided. | / |
externalRef | To specify the job scan's reference at the account side (if there is one). | empty |
shouldHaveExpectations | Set to true if you only want the job scans that already have expectations calculated. | false |
includeExpectations | Set to true if you want the results to contain the job scan's expectations. | false |
teamRoleIds | A comma-separated list of team role ids to filter on team roles.1 | empty |
workValueIds | A comma-separated list of work value ids to filter on work values.1 | empty |
offset | Sets the starting point of the query, e.g. if there are 10 job scans, then offset = 5 will get you job scans 6 to 10. | 0 |
count | The maximum number of job scans to return. | 100 |
sort | To sort the result on one or more field(s). Use the hyphen sign for sorting in descending order, e.g. -contactlastname, -createdon will first sort on last name in descending order and then on the date of creation, also in descending order. | createdon |
search | To filter on contact name, contact email, title and employer. Partial matches are allowed. | empty |
domainIds | A comma-separated list of domain ids2 to retrieve the job scans with these domains. | empty |
1 See Filter on expectations for a detailed explanation.
2 Use the call Get domains to obtain these ids.
Response
Returns a list of job scans that match the above filtering parameters.
[{"clientId": "guid","createdOn": "datetime","expectations": [{"expectationId": "guid","score": number,"outDated": boolean,"rank": number,"reportRank": number}],"id": "guid","title": "string","contactFirstName": "string","contactLastName": "string","contactEmail": "string","contactCcEmail": ["string"],"contactPhone": "string","employer": "string","externalRef": "string","domainIds": ["guid"],"schoolIds": ["guid"],"clusterIds": ["guid"]}]
Permission scopes
- read:jobscans