JAjarvi
Companies

Get Companies

Changed on

Get all companies (recruitment, sales, etc.) with their custom fields, files, and more. Results are paginated: limit defaults to 100 and caps at 1000, so read total and walk offset until you have collected every record.

get/rest/v2/companies

Request

  • Base URL
    https://functions.prod.jarvi.tech/v1/public-api
  • URL
    https://functions.prod.jarvi.tech/v1/public-api/rest/v2/companies
  • Auth
    API key in header X-API-KEY

Query parameters

updatedAfterstring

An ISO 8601 date string to filter companies updated after this date

A JSON object, sent JSON-encoded in the query string. Combine filters with _and, _or and _not. What it accepts is the CompaniesFilters schema this parameter points at, described at every filter companies accepts.

orderBystring

A JSON object string pairing one field with "asc" or "desc". Allowed fields: name, createdAt, status.order, linkedinCompanyData.foundedAt, linkedinCompanyData.linkedinEmployeeCount, linkedinCompanyData.linkedinEmployeeStartCount, linkedinCompanyData.website, legaldata.codenaf, legaldata.codenafTitle, legaldata.activity, customFieldsValue.<uuid>, customFieldsNumericValue.<uuid>.

limitnumber

The number of companies to return. Default is 100. Maximum is 1000

offsetnumber

The number of companies to skip. Default is 0.

Response

Responses for GET /api/rest/companies

totalinteger

The total number of companies matching the query

Example response

{
  "warnings": [
    {
      "operator": "_ilike",
      "field": "lastName"
    }
  ]
}

Changes

  • 873dd84c25ebRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id listCompanies was added

    • info

      api tag Companies added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status