API References - Jobpass

Notre documentation de référence sur notre API GraphQL vous aide à recevoir des candidatures plus complètes et actualisées directement dans vos outils de gestion de candidatures.

Contact

Support client

support@jobpass.com

https://support.jobpass.com/kb-tickets/new

Terms of Service

https://jobpass.com/legal/conditions-generales-utilisation/

API Endpoints

# Staging:
https://api.staging.jobpass.io/recruiter/graphql
# Production:
https:/api.jobpass.com/recruiter/graphql

Headers

Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

`getApplication`

Response

Returns an Application

Arguments

Name	Description
`id` - `ID!`

Example

Query

query GetApplication($id: ID!) {
  getApplication(id: $id) {
    id
    offer {
      id
      archived
      createdAt
      updatedAt
      deletedAt
      customID
      applications {
        ...ApplicationFragment
      }
    }
    jobProfile {
      id
      description
      user {
        ...UserFragment
      }
      languages {
        ...LanguageFragment
      }
      socialNetworks {
        ...SocialNetworkFragment
      }
      experiences {
        ...ExperiencesFragment
      }
      interventions {
        ...InterventionFragment
      }
      publications {
        ...PublicationFragment
      }
      skills {
        ...SkillFragment
      }
      files {
        ...MetadataFileFragment
      }
    }
    entity {
      id
      name
      customID
      siret
      offers {
        ...OfferFragment
      }
    }
    state
    cancelledAt
    createdAt
    motivationMessage
    recruiterRefusalReason
    recruiterRefusalMessage
  }
}

Variables

{ "id": 4 }

Response

{
"data": {
"getApplication": {
"id": 4,
"offer": Offer,
"jobProfile": JobProfile,
"entity": Entity,
"state": "PENDING",
"cancelledAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"motivationMessage": "abc123",
"recruiterRefusalReason": "NOT_ENOUGH_EXPERIENCE",
"recruiterRefusalMessage": "abc123"
}
}
}

Queries

`getFile`

Response

Returns a File

Arguments

Name	Description
`id` - `ID!`

Example

Query

query GetFile($id: ID!) {
  getFile(id: $id) {
    id
    metadata {
      id
      type
      name
      createdAt
    }
    content
  }
}

Variables

{ "id": "4" }

Response


{
    "data": {
        "getFile": {
        "id": "4",
        "metadata": MetadataFile,
        "content": DataURI
        }
    }
}

Queries

`getJobProfile`

Response

Returns a JobProfile!

Arguments

Name	Description
`input` - `UserJobProfileGet!`

Example

Query

query GetJobProfile($input: UserJobProfileGet!) {
  getJobProfile(input: $input) {
    id
    description
    user {
      id
      verified
      available
      workSearchingStatus
      workSearchingContracts {
        ...ContractResearchParametersFragment
      }
      workSearchingJobs {
        ...OccupationMapperFragment
      }
      localityPreferences {
        ...PlaceFragment
      }
      workingPreference {
        ...WorkingPreferenceFragment
      }
      meansOfLocomotion
      freelance {
        ...FreelanceFragment
      }
      contacts {
        ...ContactFragment
      }
      firstName
      lastName
      civility
      languages {
        ...LanguageFragment
      }
      dateOfBirth
      isoCountryOfBirth
      isoNationality
      createdAt
    }
    languages {
      iso639_1
      level
    }
    socialNetworks {
      url
      name
    }
    experiences {
      id
      organisation {
        ...OrganisationRawFragment
      }
      name
      description
      address {
        ...UserAddressFragment
      }
    }
    interventions {
      id
      establishment
      time
      description
    }
    publications {
      id
      time
      link
      description
    }
    skills {
      id
      name
    }
    files {
      id
      type
      name
      createdAt
    }
  }
}

Variables

{"input": UserJobProfileGet}

Response

{
"data": {
"getJobProfile": {
"id": "4",
"description": "xyz789",
"user": User,
"languages": [Language],
"socialNetworks": [SocialNetwork],
"experiences": [Experiences],
"interventions": [Intervention],
"publications": [Publication],
"skills": [Skill],
"files": [MetadataFile]
}
}
}

Queries

`queryApplication`

Response

Returns an ApplicationPayload!

Arguments

Name	Description
`filter` - `ApplicationFilter!`

Example

Query

query QueryApplication($filter: ApplicationFilter!) {
  queryApplication(filter: $filter) {
    data {
      id
      offer {
        ...OfferFragment
      }
      jobProfile {
        ...JobProfileFragment
      }
      entity {
        ...EntityFragment
      }
      state
      cancelledAt
      createdAt
      motivationMessage
      recruiterRefusalReason
      recruiterRefusalMessage
    }
  }
}

Variables

{"filter": ApplicationFilter}

Response

{"data": {"queryApplication": {"data": [Application]}}}

Queries

`queryEntity`

Response

Returns an EntitiesPayload!

Arguments

Name	Description
`filter` - `EntityFilter`

Example

Query

query QueryEntity($filter: EntityFilter) {
  queryEntity(filter: $filter) {
    data {
      id
      name
      customID
      siret
      offers {
        ...OfferFragment
      }
    }
  }
}

Variables

    {"filter": EntityFilter}

Response

    {"data": {"queryEntity": {"data": [Entity]}}}

Queries

`version`

Response

Returns a String!

Example

Query

query Version {
  version
}

Response

{ "data": { "version": {} } }

Mutations

`applicationUpdateState`

Response

Returns an ApplicationUpdateStatePayload!

Arguments

Name	Description
`id` - `ID!`
`input` - `ApplicationUpdateStateInput!`

Example

Query

mutation ApplicationUpdateState(
  $id: ID!
  $input: ApplicationUpdateStateInput!
) {
  applicationUpdateState(id: $id, input: $input) {
    ok
  }
}

Variables

{"id": 4, "input": ApplicationUpdateStateInput}

Response

{ "data": { "applicationUpdateState": { "ok": false } } }

Mutations

`createApplicationOffer`

Response

Returns an Application

Arguments

Name	Description
`input` - `applicationOfferInput!`

Example

Query

mutation CreateApplicationOffer($input: applicationOfferInput!) {
  createApplicationOffer(input: $input) {
    id
    offer {
      id
      archived
      createdAt
      updatedAt
      deletedAt
      customID
      applications {
        ...ApplicationFragment
      }
    }
    jobProfile {
      id
      description
      user {
        ...UserFragment
      }
      languages {
        ...LanguageFragment
      }
      socialNetworks {
        ...SocialNetworkFragment
      }
      experiences {
        ...ExperiencesFragment
      }
      interventions {
        ...InterventionFragment
      }
      publications {
        ...PublicationFragment
      }
      skills {
        ...SkillFragment
      }
      files {
        ...MetadataFileFragment
      }
    }
    entity {
      id
      name
      customID
      siret
      offers {
        ...OfferFragment
      }
    }
    state
    cancelledAt
    createdAt
    motivationMessage
    recruiterRefusalReason
    recruiterRefusalMessage
  }
}

Variables

{"input": applicationOfferInput}

Response

{
    "data": {
        "createApplicationOffer": {
        "id": 4,
        "offer": Offer,
        "jobProfile": JobProfile,
        "entity": Entity,
        "state": "PENDING",
        "cancelledAt": "2007-12-03T10:15:30Z",
        "createdAt": "2007-12-03T10:15:30Z",
        "motivationMessage": "abc123",
        "recruiterRefusalReason": "NOT_ENOUGH_EXPERIENCE",
        "recruiterRefusalMessage": "abc123"
    }
  }
}

Mutations

`createCertifiedExperience`

Response

Returns a CreateCertifiedExperiencePayload

Arguments

Name	Description
`input` - `CreateCertifiedExperienceInput!`

Example

Query

mutation CreateCertifiedExperience($input: CreateCertifiedExperienceInput!) {
  createCertifiedExperience(input: $input) {
    experience {
      id
      organisation {
        ...OrganisationRawFragment
      }
      name
      description
      address {
        ...UserAddressFragment
      }
      job {
        ...OccupationDirectoryFragment
      }
      start
      end
      contract {
        ...ContractFragment
      }
      contractType
    }
  }
}

Variables

{"input": CreateCertifiedExperienceInput}

Response

{
"data": {
"createCertifiedExperience": {
"experience": WorkingExperience
}
}
}

Mutations

`ping`

Response

Returns a String!

Arguments

Name	Description
`value` - `String!`

Example

Query

mutation Ping($value: String!) {
  ping(value: $value)
}

Variables

{ "value": "xyz789" }

Response

{ "data": { "ping": {} } }

Mutations

`updateEntity`

Response

Returns an EntityPayload

Arguments

Name	Description
`id` - `ID!`
`input` - `EntityInput!`

Example

Query

mutation UpdateEntity($id: ID!, $input: EntityInput!) {
  updateEntity(id: $id, input: $input) {
    entity {
      id
      name
      customID
      siret
      offers {
        ...OfferFragment
      }
    }
  }
}

Variables

{
"id": "4",
"input": EntityInput
}

Response

{"data": {"updateEntity": {"entity": Entity}}}

Types

Application

Description

An Application object represents an action that is initiated by a user who wishes to work for a recruiter through JobPass receptors. It involves sharing its JobPass data with the recruiter and can result in a hire or a rejection.

Fields

Field Name	Description
`id` - `ID!`
`offer` - `Offer!`
`jobProfile` - `JobProfile`	Offer linked to the Application. It can be a JobOffer or Spontaneous
`entity` - `Entity!`
`state` - `ApplicationState!`
`cancelledAt` - `DateTime`
`createdAt` - `DateTime!`	Date of the application
`motivationMessage` - `String`	Message that the user can add to his application before sending it
`recruiterRefusalReason` - `ApplicationRefusalReason`	Reason why the recruiter refuses the application
`recruiterRefusalMessage` - `String`	Additionnal message that the recruiter can send when he refuses the application

Example

{
"id": "4",
"offer": Offer,
"jobProfile": JobProfile,
"entity": Entity,
"state": "PENDING",
"cancelledAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"motivationMessage": "xyz789",
"recruiterRefusalReason": "NOT_ENOUGH_EXPERIENCE",
"recruiterRefusalMessage": "xyz789"
}

Input Field	Description
`dateRange` - `DateTimeRangeInput!`
`entityFilter` - `EntityFilter`

Enum Value	Description
`NOT_ENOUGH_EXPERIENCE`	The user has not enough experience for this job
`NOT_REQUIRED_SKILLS`	The user has not enough skill for this job
`JOB_OFFER_FILLED`	The recruiter has hired someone else for this job
`NO_LONGER_HIRING`	The recruiter is no longer hiring
`OTHER`

Enum Value	Description
`PENDING`	The application has been sent by the user but hasn't bee treated by the recruiter
`ACCEPTED`	The recruiter has accepted the user's application
`REFUSED_BY_RECRUITER`	The recruiter has refused the user's application and has given a reason
`CANCELLED_BY_USER`	The user has cancelled his application. The recruiter can't have access to his data anymore

Enum Value	Description
`ACCEPTED`
`REFUSED`

# API References

API References - Jobpass

Contact

Terms of Service

API Endpoints

Headers

Queries

getApplication

Response

Arguments

Example

Query

Variables

Response

getFile

Response

Arguments

Example

Query

Variables

Response

getJobProfile

Response

Arguments

Example

Query

Variables

Response

queryApplication

Response

Arguments

Example

Query

Variables

Response

queryEntity

Response

Arguments

Example

Query

Variables

Response

version

Response

Example

Query

Response

Mutations

applicationUpdateState

Response

Arguments

Example

Query

Variables

Response

createApplicationOffer

Response

Arguments

Example

Query

Variables

Response

createCertifiedExperience

Response

Arguments

Example

Query

Variables

Response

ping

Response

Arguments

Example

Query

Variables

Response

updateEntity

Response

Arguments

Example

`getApplication`

`getFile`

`getJobProfile`

`queryApplication`

`queryEntity`

`version`

`applicationUpdateState`

`createApplicationOffer`

`createCertifiedExperience`

`ping`

`updateEntity`