Get Profiles
curl --request GET \
  --url https://functions.prod.jarvi.tech/v1/public-api/rest/v2/profiles \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "9ef1c5db-9c40-4329-aec6-d3b3230b45b9",
      "addedAt": "2025-01-06T16:26:40.484813+00:00",
      "birthday": null,
      "canSendInMail": null,
      "countConnexionsWithThisProfile": 0,
      "countInvitationsScheduledToThisProfile": 0,
      "countInvitationsSentToThisProfile": 0,
      "countApplicationsFromThisProfile": 0,
      "countMeetingsDoneWithThisProfile": 0,
      "countMeetingsScheduledWithThisProfile": 0,
      "countMessagesReceivedFromThisProfile": 0,
      "countMessagesScheduledToThisProfile": 0,
      "countMessagesSentToThisProfile": 0,
      "createdAt": "2025-01-06T16:26:40.484813+00:00",
      "createdByUserId": "0024184e-0780-4f3b-be35-9c057ad94ec4",
      "deletedAt": null,
      "distance": null,
      "externalId": null,
      "externalIdSource": null,
      "firstInteractionDate": null,
      "firstName": "Johan",
      "firstNameParsed": null,
      "firstNameManual": "Johan",
      "groupId": "952582b4-bb51-461e-b566-0e5f980f4660",
      "countResumes": 0,
      "headline": null,
      "imageId": null,
      "isTalent": true,
      "isContact": false,
      "isHiring": null,
      "isOpenToNewOpportunities": null,
      "isInfluencer": false,
      "isPremium": false,
      "lastInteractionDate": null,
      "lastPastInteractionDate": null,
      "lastInteractionType": null,
      "lastPositionStartDate": null,
      "lastName": "Barri",
      "lastNameParsed": null,
      "lastNameManual": "Barri",
      "linkedinId": null,
      "locationId": null,
      "manualLocationId": null,
      "parsedLocationId": null,
      "memberId": null,
      "preferredEmailAddress": null,
      "profileUrl": null,
      "publicIdentifier": null,
      "primaryLocale": null,
      "searchString": "johan barri johan",
      "source": "MANUAL",
      "statusId": "b2d697e3-668d-42d1-a340-1920f920a7ca",
      "talentIdentifier": null,
      "linkedinSalesNavigatorIdentifier": null,
      "linkedinSignificantIdentifier": null,
      "summary": null,
      "updatedAt": "2025-01-06T16:26:40.484813+00:00",
      "pendingExecuteTriggerTasks": [],
      "unreadMessagesNotifications": {
        "aggregate": {
          "count": 0,
          "__typename": "notifications_aggregate_fields"
        },
        "__typename": "notifications_aggregate"
      },
      "protectedCompaniesWorksIn": [],
      "createdBy": {
        "displayName": "Sarah Le Roué",
        "id": "0024184e-0780-4f3b-be35-9c057ad94ec4",
        "__typename": "users"
      },
      "image": null,
      "location": null,
      "files": [],
      "positions": [],
      "positions_sources": {
        "aggregate": {
          "count": 0,
          "__typename": "profiles_positions_aggregate_fields"
        },
        "nodes": [],
        "__typename": "profiles_positions_aggregate"
      },
      "locales": [],
      "educations": [],
      "education_sources": {
        "aggregate": {
          "count": 0,
          "__typename": "profiles_educations_aggregate_fields"
        },
        "nodes": [],
        "__typename": "profiles_educations_aggregate"
      },
      "fieldsValues": [],
      "emailAddresses": [],
      "phoneNumbers": [],
      "assignees": [
        {
          "user": {
            "displayName": "Sarah Le Roué",
            "id": "0024184e-0780-4f3b-be35-9c057ad94ec4",
            "__typename": "users"
          },
          "__typename": "profiles_assignees_cache"
        }
      ],
      "status": {
        "title": "jarvis.statuses.notContacted",
        "color": {
          "id": "#d1c4e9",
          "name": "deep-purple-100",
          "__typename": "colors"
        },
        "isAuto": true,
        "id": "b2d697e3-668d-42d1-a340-1920f920a7ca",
        "isProtected": false,
        "__typename": "statuses"
      },
      "associations": [],
      "__typename": "profiles"
    }
  ],
  "total": 1
}
You must use your private api key for this request.

You can completely customize all information for each profile using Custom Fields. Click on this link to understand how to read and write information in custom fields.

Authorizations

X-API-KEY
string
header
required

Query Parameters

updatedAfter
string

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

where
string

A JSON object string containing the graphQL filters for more advanced usage

orderBy
string

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

limit
number

The number of profiles to return. Default is 100, max is 2000

offset
number

Return profiles starting from this offset

Response

200 - application/json

Responses for GET /api/rest/profiles

The response is of type object.