# Get all employees

**GET /api/v1/employee**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)



### Query parameters
- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, tags, groups].
- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.
- **filter[name]** (string)
  Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.
- **filter[email]** (string)
  Filter employees that have an email with a partial match.
- **filter[type]** (string)
  Comma separated string to filter by different employee types.  Valid types are [owner, admin, member].
- **filter[created_after]** (string)
  Date to filter when the client was created after.
- **filter[created_before]** (string)
  Date to filter when the client was created before.
- **filter[tags]** (string)
  Comma separated list of tag names or tag UUIDs.
- **filter[groups]** (string)
  Comma separated list of partial groups names or group UUIDs.
- **filter[exclude_groups]** (string)
  Provide a group UUID (or multiple as a comma-separated string) to filter employees within the provided groups out from the response.
- **filter[departments]** (string)
  Comma separated list of departments the employee is in.
- **filter[include]** (string)
  Comma separated list of employee UUIDs that should always be returned no matter what other filters are applied.
- **sort** (string)
  Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC.  Defaults to 'first_name'.
- **per_page** (integer)
  Number of results to return with pagination (Default 15. Max 500).


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **type** (string)
  Account type
- **role** (string)
  Account role
- **first_name** (string)
  First name
- **last_name** (string)
  Last name
- **name** (string)
  Name
- **email** (string)
  (Deprecated - Please use primary_email instead). The email of the account.
- **photo_url** (string)
  URL for initial avatar image
- **firm** (object)
  Firm
- **primary_phone_number** (object)
  Primary phone number
- **primary_email** (object)
  Primary email
- **current_time_entry** (object)
  Current time entry
- **assigned_adviser** (object)
  Assigned adviser
- **assigned_administrator** (object)
  Assigned administrator
- **assigned_paraplanner** (object)
  Assigned paraplanner
- **introduced_by** (object)
  Introduced by
- **groups** (array[object])
  Groups
- **tags** (array[object])
  Tags
- **owners** (array[object])
  Accounts that own this account
- **first_contact_date** (string)
  First contact date
- **next_review_date** (string)
  Next review date
- **previous_review_date** (string)
  Previous review date
- **anniversary_review_date** (string)
  Anniversary review date
- **with_login** (boolean)
  Denotes whether the account has a login to Plannr
- **has_joint_account** (boolean)
  Denotes whether this account belongs to a joint account too
- **can_be_deleted** (string)
  Denotes if the account can be deleted
- **joint_account_circle** (object)
  This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.
- **circles** (array[object])
  The circles the account belongs to
- **ownership_percentage** (integer)
  Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
- **inactive_at** (string)
  Inactive from date
- **custom_fields** (array[object])
  Any custom fields on the model.
- **external_references** (array[object])
  The external references that have been added to the client.


[Powered by Bump.sh](https://bump.sh)