# List People

Returns a paginated list of individuals in the system.

Endpoint: GET /v1/people
Version: v1
Security: ApiKey

## Query parameters:

  - `page` (integer)
    The specific page of results requested.

  - `page_size` (integer)
    The number of results in each page.

  - `archived` (boolean)
    Indicates if results should be filtered by their archived status.

## Response 200 fields (application/json):

  - `count` (integer)
    The number of results in the current page.

  - `total` (integer)
    The total number of results that fulfill the request.

  - `page` (integer)
    The current page of results being returned.

  - `total_pages` (integer)
    The total number of available pages that fulfill the request.

  - `page_size` (integer)
    The number of results in each page returned.

  - `results` (array, required)
    The array of result objects for the current page.

  - `results.id` (string)
    The unique identifier of the Person in Parallax.

  - `results.given_name` (string,null)
    The first name or given name of the Person.

  - `results.family_name` (string,null)
    The last name or family name of the Person.

  - `results.email_address` (string,null)
    The email address associated with the Person.

  - `results.capacity` (number,null)
    The capacity of this Person if they are using a custom capacity instead of their Role's capacity.Note: This value can be cleared out by sending null in the request body.

  - `results.role_id` (string)
    Id of the Role to be used as the primary (default) Role for this person.

  - `results.billable_utilization_target` (number,null)
    The billable utilization target of this Person if they are using a custom target utilization instead of their Role's target utilization. Note: This value can be cleared out by sending null in the request body.

  - `results.billable` (boolean)
    Indicates whether the Person's work is considered billable for client projects.

  - `results.start_date` (string,null)
    The earliest date this Person is available for resourcing on a Project. The Person's capacity prior to this date is 0%.

  - `results.end_date` (string,null)
    If this Person will have or has had their employment or contract terminated, this is the last date they are available for resourcing on a project. They will automatically be archived after this date has passed, and their capacity will drop to 0%. This value can be cleared out by sending null in the request body.

  - `results.worker_type` (object)
    Specifies the worker classification for the Person, such as Employee or Contractor.

  - `results.tags` (array)
    A list of tags used to categorize the Person for filtering, reporting, or custom grouping.

  - `results.created_date` (string)
    The date and time when the Person record was created in Parallax.

  - `results.modified_date` (string)
    The date and time when the Person record was last modified in Parallax.

  - `results.image_url` (string,null)
    The URL of the profile image associated with the Person.

  - `results.archived` (boolean)
    Indicates whether the Person is archived and no longer active for project assignment or planning.

  - `results.current_cost_rate` (object)
    The current effective cost rate for the person. This will return the current overridden cost rate of the person, and will fall back to the current cost rate of their assigned role if there is no override.

  - `results.current_cost_rate.currency_code` (string)
    The currency code of the monetary object.

  - `results.current_cost_rate.amount` (number)
    The amount of the monetary object.

## Response 400 fields (application/json):

  - `type` (string)
    RFC reference for the error type

  - `title` (string)
    Human-readable summary of the error

  - `status` (integer)
    HTTP status code

  - `errors` (array)
    Detailed error messages for each validation failure

  - `trace_id` (string)
    Trace identifier for debugging