Skip to main content
Get Companies
curl --request GET \
  --url https://functions.prod.jarvi.tech/v1/public-api/rest/v2/companies \
  --header 'X-API-KEY: <api-key>'
{
  "companies": [
    {
      "__typename": "<string>",
      "assignees": [
        {
          "user": {
            "displayName": "<string>",
            "id": "<string>"
          }
        }
      ],
      "description": "<string>",
      "foundedAt": "<unknown>",
      "groupId": "<string>",
      "id": "<string>",
      "image": {
        "publicUrl": "<string>"
      },
      "industries": [
        {
          "industry": {
            "id": "<string>",
            "linkedinId": "<unknown>",
            "nameEnglish": "<string>",
            "nameFrench": "<string>"
          }
        }
      ],
      "linkedinEmployeeCount": 123,
      "linkedinEmployeeEndCount": 123,
      "linkedinEmployeeStartCount": 123,
      "linkedinId": "<string>",
      "linkedinUrl": "<string>",
      "name": "<string>",
      "tagline": "<string>",
      "universalName": "<string>",
      "website": "<string>",
      "createdAt": "<unknown>",
      "deletedAt": "<unknown>",
      "externalId": "<string>",
      "fieldsValues": [
        {
          "field": {
            "id": "<string>",
            "name": "<string>",
            "type": "boolean"
          },
          "fieldValue": {
            "id": "<string>",
            "name": "<string>"
          },
          "id": "<string>",
          "location": {
            "formattedAddress": "<string>",
            "id": "<string>",
            "search": "<string>"
          },
          "value": "<string>"
        }
      ],
      "files": [
        {
          "createdAt": "<unknown>",
          "file": {
            "id": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "size": 123
          },
          "fileId": "<string>",
          "updatedAt": "<unknown>"
        }
      ],
      "isProtectedUntil": "<unknown>",
      "legaldata": {
        "activity": "<string>",
        "codenaf": "<string>",
        "codenafTitle": "<string>",
        "createdAt": "<unknown>",
        "deletedAt": "<unknown>",
        "foundedAt": "<unknown>",
        "id": "<string>",
        "legalName": "<string>",
        "locations": [
          {
            "isHeadquarters": true,
            "location": {
              "administrativeAreaLevel1": "<string>",
              "administrativeAreaLevel2": "<string>",
              "center": "<unknown>",
              "countryName": "<string>",
              "formattedAddress": "<string>",
              "id": "<string>",
              "locality": "<string>",
              "postalCode": "<string>",
              "route": "<string>",
              "search": "<string>",
              "streetNumber": "<string>"
            },
            "siret": "<string>"
          }
        ],
        "siren": "<string>",
        "updatedAt": "<unknown>",
        "vatNumber": "<string>"
      },
      "projects": [
        {
          "color": {
            "id": "<string>",
            "name": "<string>"
          },
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "projectsCountPerStatusGroup": [
        {
          "count": "<unknown>",
          "status": {
            "color": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "isAuto": true,
            "isHidden": true,
            "order": "<unknown>",
            "parentId": "<string>",
            "title": "<string>"
          }
        }
      ],
      "status": {
        "color": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>",
        "isAuto": true,
        "title": "<string>"
      },
      "statusId": "<string>",
      "updatedAt": "<unknown>"
    }
  ]
}
Devi utilizzare la tua chiave API privata per questa richiesta.
Sono previsti cambiamenti a questa API nell’estate del 2025. È quindi possibile che siano necessarie modifiche da parte tua a seguito di questi sviluppi.
Puoi personalizzare completamente le informazioni di ogni profilo grazie ai Campi personalizzati. Clicca su questo link per capire come leggere e scrivere informazioni nei campi personalizzati.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
updatedAfter
string

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

​
where
string

A JSON object string containing the graphQL filters for more advanced usage. Example: {"statusId": {"_eq": "cae642f0-463c-45f5-9db5-e0a280a8e883"} }

​
orderBy
string

A JSON object string containing the order. Example: { "createdAt": "desc" }

​
limit
number

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

​
offset
number

The number of companies to skip. Default is 0.

Response

200 - application/json

Responses for GET /api/rest/companies

​
companies
companies · object[]