Lists
List lists
Changed onReturns the lists your API key can see, newest first. Visibility follows the app: your own lists, company-wide lists, and team lists whose owner shares a team with you. The key acts as its user — it does not see every list in the agency. Integrations that need agency-wide reach want a public list or an admin owner.
get/api/v1/lists
Request
- Base URLhttps://api.recruitwithatlas.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
entityType'candidate' | 'contact'
Filter by list type
pageinteger
Page number (1-indexed)
Example:1
pageSizeinteger
Items per page (max 100)
Example:25
perPageinteger
Alias for pageSize
Response
Paginated lists
Changes
- info
endpoint added
- info