Employer
The Employer feature allows the user to view, add, modify or delete employers for the practice.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Get practice's list of employees
GET
/v1/{practiceid}/employers
Retrieves a list of available patient employers
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
exactname
string
The name of the employer (exact match).
city
string
The city of the employer (exact match).
zip
string
The zip of the employer (exact match).
name
string
The name of the employer (partial match).
address
string
The address of the employer (partial match).
phone
string
The phone of the employer (exact match).
state
string
The state of the employer (exact match).
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
address
string
The address of the employer.
city
string
The city of the employer.
fax
string
The fax number of the employer.
id
string
The practice specific ID for this employer.
name
string
The name of the employer.
notes
string
Notes about the employer; likely not patient-facing.
ordering
string
If present, an ordering for this employer for search results.
phone
string
The phone number of the employer.
state
string
The state of the employer.
zip
string
The zip code of the employer.
Example Code
Create new employee record
POST
/v1/{practiceid}/employers
Creates a record for an employer
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
employerid
integer
The ID of the employer created.
Example Code
Delete an employee record
DELETE
/v1/{practiceid}/employers/{employerid}
Deletes the record of a specified employer
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
employerid
integer
employerid
practiceid
integer
practiceid
Output Parameters
Expand all
success
string
Returns true/false if the operation was successful.
Example Code
Get specific employee record
GET
/v1/{practiceid}/employers/{employerid}
Retrieves information of a single employer detail
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
employerid
integer
employerid
practiceid
integer
practiceid
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
address
string
The address of the employer.
city
string
The city of the employer.
fax
string
The fax number of the employer.
id
string
The practice specific ID for this employer.
name
string
The name of the employer.
notes
string
Notes about the employer; likely not patient-facing.
ordering
string
If present, an ordering for this employer for search results.
phone
string
The phone number of the employer.
state
string
The state of the employer.
zip
string
The zip code of the employer.
Example Code
Update specific employee record
PUT
/v1/{practiceid}/employers/{employerid}
Modifies information of a specific employer
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
employerid
integer
employerid
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Returns true/false if the operation was successful.
Example Code
Undelete specific employee record
PUT
/v1/{practiceid}/employers/{employerid}/undelete
Re-active a deleted the record of a specified employer
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
employerid
integer
employerid
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
success
string
Returns true/false if the operation was successful.
Example Code