RErecruitwithatlas
Users

List active users

Changed on

Use this endpoint to retrieve a list of all active users (consultants) in your Atlas account.

In Atlas, a user is a member of your team who has a login - for example, a recruiter, a researcher, or an admin. This endpoint is useful when you need to look up a user's ID before using it in another API call - for example, when creating a note on a person (which requires the ID of the user the note is attributed to), or when filtering projects by owner or member.

What you can filter by:

  • email - pass an email address to find a specific user. This is the most common use case: if you know the email address of a consultant, you can use this endpoint to look up their Atlas user ID.

Pagination: Results are returned in pages. The response includes a pagination object telling you the current page, how many results are per page, the total number of users, and the total number of pages. Use the page and pageSize query parameters to navigate through results.

What you get back: Each user includes their Atlas user ID, full name, email address, job role (for example "Sourcer" or "Business Development", or null if none is set), and the date their account was created. Only active (non-deactivated) users are returned.

get/api/v1/users

Request

Query parameters

pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:100
perPageinteger

Alias for pageSize

emailstring email

Filter by exact email address

Example:user@agency.com

Response

Paginated list of active users

status'ok' required

Example response

{
  "data": [
    {
      "jobRole": {
        "name": "Business Development"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 100,
    "total": 10,
    "totalPages": 1
  }
}

Changes