Search
K
account

EOR

1.3.0OAS 3.0

This API set provides comprehensive capabilities for accessing detailed information related to Employees and their Employment within the EOR product. It is designed to offer a single point of access for critical HR, contractual, and financial data, enabling seamless integration with external systems for reporting, management, and operational purposes.

API Base URL
  • Server 1:https://api-test.g-p.dev/api

    Test

Security
BearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Employee

List Employees

Retrieve a paginated list of employees in your organization, with filters for name, status, or email.

get
https://api-test.g-p.dev/api/v1/employees

Query Parameters

sortstring

Name of field used for sorting. Result of the request is sorted by record creation time by default.

Example:status

orderstring

Sorting order. Default ASC.

Allowed values:ascdesc

Example:asc

firstNamestring

Filter by the firstName key. Values are separated by a single comma.

Example:adam,eve

lastNamestring

Filter by the lastName key. Values are separated by a single comma.

Example:smith,weatherwax

statusstring

Filter by the status key. Values are separated by a single comma.

Example:NEW,ACTIVE

personalEmailstring

Filter by the personalEmail key. Values are separated by a single comma.

Example:email1@g-p.com,email2@g-p.com

cursorstring

Cursor identifier for pagination

Example:c2Rmc2RmZHNkc3Nkc2RzZA==

limitinteger

How many entry returned. Min 5, max 100. Default is 20

Default:20

>= 5<= 100

Example:25

Headers

x-request-idstring(uuid)

Unique ID to track the request

Example:1a51d8bb-555a-4197-8bd8-164814975667

x-correlation-idstring(uuid)

(Deprecated) Unique ID to track a group of requests part of a single flow

Example:51a6e3ca-56f3-4532-a143-812aa4710cdc

Response

application/json

Success Response

requestDataobjectrequired
Show Child Parameters
employeesarray[object]required
Show Child Parameters
pageobjectrequired

Pagination data

Show Child Parameters
 
application/json