Return a list of contracts.

get https://sandbox-api.kenjo.io/api/v1/compensation/contracts

This endpoint returns a paginated list of employment contracts. The URL params help to return more accurate results.

Query Params

contractTypeId

string

Optional filter. This field allows you to retrieve contracts based on their contractTypeId. It can accept two formats:

1. A single contractTypeId as a unique string.
Example: contractTypeId=80a2db290da29e126a18789c

2. Multiple contractTypeId values separated by commas (up to a maximum of 15 values).
Example: contractTypeId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

_userId

string

Optional filter. This field allows you to retrieve contracts based on their _userId. It can accept two formats:

1. A single _userId as a unique string.
Example: _userId=80a2db290da29e126a18789c

2. Multiple _userId values separated by commas (up to a maximum of 15 values).
Example: _userId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

_companyId

string

Optional filter. This field allows you to retrieve contracts based on their _companyId. It can accept two formats:

1. A single _companyId as a unique string.
Example: _companyId=80a2db290da29e126a18789c

2. Multiple _companyId values separated by commas (up to a maximum of 15 values).
Example: _companyId=80a2db290da29e126a18789c,80a2db290da29e126a18789b,80a2db290da29e126a187891. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.

offset

number

Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.

limit

number

Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50 users. The maximum value of the limit is 100 users per page. Only are valid the following limit values: 25, 50 and 100.

Headers

Authorization

string

required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox-api.kenjo.io/api/v1/compensation/contracts \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK.

400BAD REQUEST. This is a wrong request in the client side due to invalid body or params.