[Offers] List

Get Offers

curl --request GET \
  --url https://functions.prod.jarvi.tech/v1/api/rest/v2/offers \
  --header 'X-API-KEY: <api-key>'

{
  "data": [
    {
      "__typename": "<string>",
      "assignees": [
        {
          "user": {
            "displayName": "<string>",
            "email": "<unknown>",
            "id": "<string>"
          }
        }
      ],
      "color": {
        "id": "<string>",
        "name": "<string>"
      },
      "colorId": "<string>",
      "company": {
        "companyPublicData": {
          "description": "<string>",
          "foundedAt": "<unknown>",
          "id": "<string>",
          "image": {
            "publicUrl": "<string>"
          },
          "linkedinEmployeeCount": 123,
          "linkedinEmployeeEndCount": 123,
          "linkedinEmployeeStartCount": 123,
          "linkedinUrl": "<string>",
          "name": "<string>",
          "tagline": "<string>",
          "website": "<string>"
        },
        "description": "<string>",
        "id": "<string>"
      },
      "companyId": "<string>",
      "createdAt": "<unknown>",
      "deletedAt": "<unknown>",
      "externalId": "<string>",
      "fieldsValues": [
        {
          "field": {
            "id": "<string>",
            "name": "<string>",
            "purpose": "business_estimated_revenue",
            "type": "boolean"
          },
          "fieldValue": {
            "id": "<string>",
            "name": "<string>",
            "technicalValue": "<string>"
          },
          "id": "<string>",
          "location": {
            "administrativeAreaLevel1": "<string>",
            "administrativeAreaLevel2": "<string>",
            "countryName": "<string>",
            "countryShortName": "<string>",
            "formattedAddress": "<string>",
            "id": "<string>",
            "locality": "<string>",
            "postalCode": "<string>",
            "search": "<string>"
          },
          "value": "<string>"
        }
      ],
      "files": [
        {
          "createdAt": "<unknown>",
          "file": {
            "id": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "size": 123
          },
          "fileId": "<string>",
          "updatedAt": "<unknown>"
        }
      ],
      "group": {
        "id": "<string>",
        "name": "<string>"
      },
      "groupId": "<string>",
      "id": "<string>",
      "ignoreHistoryBeforeProjectCreatedAt": true,
      "isMadeForRecruitment": true,
      "isMadeForSales": true,
      "jobBoardsOffers": [
        {
          "id": "<string>"
        }
      ],
      "linkedinContractId": 123,
      "linkedinId": "<string>",
      "linkedinIdType": "LINKEDIN_SALES_NAVIGATOR_LIST",
      "name": "<string>",
      "presetId": "<string>",
      "profilesCountPerStatusGroup": [
        {
          "count": "<unknown>",
          "status": {
            "color": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "isAuto": true,
            "isHidden": true,
            "order": "<unknown>",
            "parentId": "<string>",
            "title": "<string>"
          }
        }
      ],
      "projectJobBoards": [
        {
          "createdAt": "<unknown>",
          "deletedAt": "<unknown>",
          "enabledAt": "<unknown>",
          "id": "<string>",
          "jobBoard": {
            "canonicalName": "<string>",
            "id": "<string>"
          },
          "projectId": "<string>",
          "updatedAt": "<unknown>"
        }
      ],
      "referenceId": "<string>",
      "status": {
        "color": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>",
        "isAuto": true,
        "title": "<string>"
      },
      "statusId": "<string>",
      "updatedAt": "<unknown>",
      "user": {
        "disabled": true,
        "displayName": "<string>",
        "email": "<unknown>",
        "id": "<string>"
      },
      "userId": "<string>"
    }
  ],
  "total": 123
}

GET

rest

offers

Get Offers

curl --request GET \
  --url https://functions.prod.jarvi.tech/v1/api/rest/v2/offers \
  --header 'X-API-KEY: <api-key>'

{
  "data": [
    {
      "__typename": "<string>",
      "assignees": [
        {
          "user": {
            "displayName": "<string>",
            "email": "<unknown>",
            "id": "<string>"
          }
        }
      ],
      "color": {
        "id": "<string>",
        "name": "<string>"
      },
      "colorId": "<string>",
      "company": {
        "companyPublicData": {
          "description": "<string>",
          "foundedAt": "<unknown>",
          "id": "<string>",
          "image": {
            "publicUrl": "<string>"
          },
          "linkedinEmployeeCount": 123,
          "linkedinEmployeeEndCount": 123,
          "linkedinEmployeeStartCount": 123,
          "linkedinUrl": "<string>",
          "name": "<string>",
          "tagline": "<string>",
          "website": "<string>"
        },
        "description": "<string>",
        "id": "<string>"
      },
      "companyId": "<string>",
      "createdAt": "<unknown>",
      "deletedAt": "<unknown>",
      "externalId": "<string>",
      "fieldsValues": [
        {
          "field": {
            "id": "<string>",
            "name": "<string>",
            "purpose": "business_estimated_revenue",
            "type": "boolean"
          },
          "fieldValue": {
            "id": "<string>",
            "name": "<string>",
            "technicalValue": "<string>"
          },
          "id": "<string>",
          "location": {
            "administrativeAreaLevel1": "<string>",
            "administrativeAreaLevel2": "<string>",
            "countryName": "<string>",
            "countryShortName": "<string>",
            "formattedAddress": "<string>",
            "id": "<string>",
            "locality": "<string>",
            "postalCode": "<string>",
            "search": "<string>"
          },
          "value": "<string>"
        }
      ],
      "files": [
        {
          "createdAt": "<unknown>",
          "file": {
            "id": "<string>",
            "mimeType": "<string>",
            "name": "<string>",
            "size": 123
          },
          "fileId": "<string>",
          "updatedAt": "<unknown>"
        }
      ],
      "group": {
        "id": "<string>",
        "name": "<string>"
      },
      "groupId": "<string>",
      "id": "<string>",
      "ignoreHistoryBeforeProjectCreatedAt": true,
      "isMadeForRecruitment": true,
      "isMadeForSales": true,
      "jobBoardsOffers": [
        {
          "id": "<string>"
        }
      ],
      "linkedinContractId": 123,
      "linkedinId": "<string>",
      "linkedinIdType": "LINKEDIN_SALES_NAVIGATOR_LIST",
      "name": "<string>",
      "presetId": "<string>",
      "profilesCountPerStatusGroup": [
        {
          "count": "<unknown>",
          "status": {
            "color": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "isAuto": true,
            "isHidden": true,
            "order": "<unknown>",
            "parentId": "<string>",
            "title": "<string>"
          }
        }
      ],
      "projectJobBoards": [
        {
          "createdAt": "<unknown>",
          "deletedAt": "<unknown>",
          "enabledAt": "<unknown>",
          "id": "<string>",
          "jobBoard": {
            "canonicalName": "<string>",
            "id": "<string>"
          },
          "projectId": "<string>",
          "updatedAt": "<unknown>"
        }
      ],
      "referenceId": "<string>",
      "status": {
        "color": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>",
        "isAuto": true,
        "title": "<string>"
      },
      "statusId": "<string>",
      "updatedAt": "<unknown>",
      "user": {
        "disabled": true,
        "displayName": "<string>",
        "email": "<unknown>",
        "id": "<string>"
      },
      "userId": "<string>"
    }
  ],
  "total": 123
}

You must use your public api key for this request. You need to cache the data on your end to comply with the daily rate limits.

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

Authorizations

X-API-KEY

string

header

required

Query Parameters

limit

number

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

offset

number

The number of offers to skip. Default is 0.

Response

200 - application/json

Responses for GET /api/rest/projects

data

projects · object[]

Show child attributes

data.__typename

string

data.assignees

projects_assignees · object[]

Show child attributes

data.assignees.user

users · object

Show child attributes

data.assignees.user.displayName

string

data.assignees.user.email

unknown

data.assignees.user.id

string

data.color

colors · object

The project color as set up by the user

Show child attributes

data.color.id

string

The hex color code

data.color.name

string | null

data.colorId

string | null

data.company

companies · object

The company associated with the project

Show child attributes

data.company.companyPublicData

companies_publicdata · object

Public informations about this company

Show child attributes

data.company.companyPublicData.description

string | null

data.company.companyPublicData.foundedAt

unknown

data.company.companyPublicData.id

string

data.company.companyPublicData.image

images · object

Logo of the company

Show child attributes

data.company.companyPublicData.image.publicUrl

string | null

data.company.companyPublicData.linkedinEmployeeCount

integer | null

data.company.companyPublicData.linkedinEmployeeEndCount

integer | null

data.company.companyPublicData.linkedinEmployeeStartCount

integer | null

data.company.companyPublicData.linkedinUrl

string | null

data.company.companyPublicData.name

string

data.company.companyPublicData.tagline

string | null

data.company.companyPublicData.website

string | null

data.company.description

string | null

data.company.id

string

data.companyId

string | null

data.createdAt

any

data.deletedAt

unknown

data.externalId

string | null

data.fieldsValues

projects_fieldsvalues · object[]

Show child attributes

data.fieldsValues.field

fields · object

columns and relationships of "fields"

Show child attributes

data.fieldsValues.field.id

string

data.fieldsValues.field.name

string

data.fieldsValues.field.purpose

enum<string> | null

Available options:

business_estimated_revenue,

joboffer,

joboffer_activity_area,

joboffer_benefits,

joboffer_company_description,

joboffer_company_name,

joboffer_contract_duration_in_months,

joboffer_contract_type,

joboffer_description,

joboffer_employee_status,

joboffer_is_fulltime,

joboffer_job_category,

joboffer_level_of_study,

joboffer_location,

joboffer_min_years_of_experience,

joboffer_profile_description,

joboffer_remote_days_per_week,

joboffer_salary_is_public,

joboffer_salary_per_year_max,

joboffer_salary_per_year_min,

joboffer_salary_range_eur,

joboffer_title

data.fieldsValues.field.type

enum<string>

Available options:

boolean,

date,

group,

multiplechoice,

number,

rating,

richtext,

singlechoice,

singlelocation,

text

data.fieldsValues.fieldValue

fieldsvalues · object

columns and relationships of "fieldsvalues"

Show child attributes

data.fieldsValues.fieldValue.id

string

data.fieldsValues.fieldValue.name

string

data.fieldsValues.fieldValue.technicalValue

string | null

data.fieldsValues.id

string

data.fieldsValues.location

locations · object

columns and relationships of "locations"

Show child attributes

data.fieldsValues.location.administrativeAreaLevel1

string | null

data.fieldsValues.location.administrativeAreaLevel2

string | null

data.fieldsValues.location.countryName

string | null

data.fieldsValues.location.countryShortName

string | null

data.fieldsValues.location.formattedAddress

string | null

data.fieldsValues.location.id

string

data.fieldsValues.location.locality

string | null

data.fieldsValues.location.postalCode

string | null

data.fieldsValues.location.search

string

data.fieldsValues.value

string | null

data.files

projects_files · object[]

Show child attributes

data.files.createdAt

any

data.files.file

files · object

columns and relationships of "storage.files"

Show child attributes

data.files.file.id

string

data.files.file.mimeType

string | null

data.files.file.name

string | null

data.files.file.size

integer | null

data.files.fileId

string

data.files.updatedAt

any

data.group

groups · object

columns and relationships of "groups"

Show child attributes

data.group.id

string

data.group.name

string

data.groupId

string | null

data.id

string

data.ignoreHistoryBeforeProjectCreatedAt

boolean

data.isMadeForRecruitment

boolean

data.isMadeForSales

boolean

data.jobBoardsOffers

jobboards_offers · object[]

Show child attributes

data.jobBoardsOffers.id

string

data.linkedinContractId

integer | null

data.linkedinId

string | null

data.linkedinIdType

enum<string> | null

Available options:

LINKEDIN_SALES_NAVIGATOR_LIST,

LINKEDIN_TALENT_PROJECT

data.name

string

data.presetId

string

data.profilesCountPerStatusGroup

projects_statuses_count_view · object[]

Show child attributes

data.profilesCountPerStatusGroup.count

unknown

data.profilesCountPerStatusGroup.status

statuses · object

columns and relationships of "statuses"

Show child attributes

data.profilesCountPerStatusGroup.status.color

colors · object

columns and relationships of "colors"

Show child attributes

data.profilesCountPerStatusGroup.status.color.id

string

data.profilesCountPerStatusGroup.status.color.name

string | null

data.profilesCountPerStatusGroup.status.id

string

data.profilesCountPerStatusGroup.status.isAuto

boolean

data.profilesCountPerStatusGroup.status.isHidden

boolean

data.profilesCountPerStatusGroup.status.order

any

data.profilesCountPerStatusGroup.status.parentId

string | null

data.profilesCountPerStatusGroup.status.title

string

data.projectJobBoards

projects_jobboards · object[]

Show child attributes

data.projectJobBoards.createdAt

any

data.projectJobBoards.deletedAt

unknown

data.projectJobBoards.enabledAt

unknown

data.projectJobBoards.id

string

data.projectJobBoards.jobBoard

jobboards · object

A job board is a website where you can publish job offers

Show child attributes

data.projectJobBoards.jobBoard.canonicalName

string

data.projectJobBoards.jobBoard.id

string

data.projectJobBoards.projectId

string

data.projectJobBoards.updatedAt

any

data.referenceId

string | null

data.status

statuses · object

columns and relationships of "statuses"

Show child attributes

data.status.color

colors · object

columns and relationships of "colors"

Show child attributes

data.status.color.id

string

data.status.color.name

string | null

data.status.id

string

data.status.isAuto

boolean

data.status.title

string

data.statusId

string | null

data.updatedAt

any

data.user

users · object

User account information. Don't modify its structure as Hasura Auth relies on it to function properly.

Show child attributes

data.user.disabled

boolean

data.user.displayName

string

data.user.email

unknown

data.user.id

string

data.userId

string | null

total

number

[Company] Create or update GraphQL

⌘I

Generalities

Use cases

REST API Reference

GraphQL API Reference

Authorizations

Query Parameters

Response