API Reference
  1. Requirements API

List requirements

get
https://api.everee.com/integration/v1/requirements

The company's open requirements, newest first.

List the company's open requirements, newest first. Narrow them to a subject with subject-type and subject-id. The list is cursor-paginated: see Listing and paging. See the Guide to the Requirements API.

Query Params
string
enum

Only requirements about workers, or only about the company.

Allowed:
string

Only requirements about this subject. Needs subject-type. For WORKER, send an externalWorkerId or a workerId: an externalWorkerId is matched first. For COMPANY, send the company ID.

integer
1 to 1000
Defaults to 100

The most items to return on a page: 1 to 1,000. Defaults to 100.

string

The nextCursor of the previous page. Leave it out to get the first page.

Responses

Updated about 12 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 12 hours ago

Did this page help you?