Employee Profile

Retrieve list of employee profile

Supports searching by name, company, active status, role, and other fields using the filters parameter.

get/management/v2/employees-profile

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/management/v2/employees-profile
  • Auth
    API key in header OAuth

Query parameters

filtersstring[]

Filter employees by field values. Format: filters[]={fieldName}:{value} Multiple filters can be combined. Use the 'op' parameter to specify AND (default) or OR operation.

AND filter example (default):

GET /api/management/v2/employees-profile?filters[]=active:1&filters[]=company:10

Returns active employees from company 10 (both conditions must match)

OR filter example:

GET /api/management/v2/employees-profile?filters[]=role:5&filters[]=role:6&op=OR

Returns employees with role 5 OR 6 (either condition matches)

Available filterable fields:

  • id: Employee ID
  • company: Company ID
  • first_name: Employee first name
  • last_name: Employee last name
  • display_name: Employee display name
  • gender: Gender
  • user_id: User ID
  • active: Active status (boolean: use 1 for true, 0 for false)
  • termination_date: Termination date
  • position: Position
  • role: Role ID
opstring

Controls how multiple filters are combined. Default is AND (all filters must match). Valid values: "AND", "OR"

  • AND: All filter conditions must match (default behavior)
  • OR: Any filter condition can match. Example with AND (default):
GET /api/management/v2/employees-profile?filters[]=active:1&filters[]=company:10

Example with OR:

GET /api/management/v2/employees-profile?filters[]=role:5&filters[]=role:6&op=OR
cursorstring

Pagination cursor from a previous response. Base64 encoded value that points to the position in the result set for the next page. Use this value in subsequent requests to fetch the next page of results.

limitinteger

Maximum number of employee profiles to return in a single response. Used for pagination.

orderBystring

Field name to sort results by. The field name can be mapped through a column mapper if needed.

Response

A successful response.

successboolean
nextCursorstring

Cursor to fetch the next page of results. Base64 encoded value. Present only if more results are available. Empty string if this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.