« Back to operation list

get/coverletter/{coverletterId}

Candidates have the option of saving cover letters to attach to job offer applications that required them. This operation returns a cover letter available for the authenticated user and identified by the coverletterId informed.

Try it!

Request

Resource URL

https://api.infojobs.net/api/1/coverletter/{coverletterId}

Security

  • User Role: role_candidate
  • Scope: cover_letter_read

Parameters

Name Description

coverletterId

String

Required

Identifier of the coverletter to retrieve. This coverletter must belong to the authenticated user.

Example values: 70628530-6d45-483a-8327-d8c81b

Response

Response fields

Fields related to the cover letter
Name Description

name

String

The name with wich the cover letter was saved.

Maximum lenght: 100

key

String

The cover letter identifier

Maximum lenght: 100

text

String

The cover letter text.

main

Boolean

True if the cover letter is the default chosen by the authenticated user to apply to job offers, false otherwise.

Error Codes

Code Description

744

There is no cover letter with key, use a valid existing key to retrieve a cover letter

Examples

This example retrieves the cover letter requested by the user and associated to the authenticated user.

Request

GET https://api.infojobs.net/api/1/coverletter/70628530-6d45-483a-8327-d8c81b0a62ab/

Response

 [
{
"name": "Presentación",
"key": "70628530-6d45-483a-8327-d8c81b0a62ab",
"text": "hello world",
"main": true

 }
]
Try it!

Sections: