Skip to main content
GET
/
resume
/
{resume_id}
/
education
/
{id}
/
Get education by id
curl --request GET \
  --url https://api.letraz.app/api/v1/resume/{resume_id}/education/{id}/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "user": "<string>",
  "resume_section": "<string>",
  "institution_name": "<string>",
  "field_of_study": "<string>",
  "degree": "<string>",
  "country": "<string>",
  "started_from_month": 6,
  "started_from_year": 2000,
  "finished_at_month": 6,
  "finished_at_year": 2000,
  "current": true,
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Education ID of the education you want to retrieve

​
resume_id
string
required

Resume ID of the resume the education belongs to. If you want to interact with the base educations, just put base in here

Response

​
id
string
required
​
user
string
required

The user who the education entry belongs to.

​
resume_section
string
required
​
institution_name
string
required

The name of the institution the user studied at.

Maximum length: 250
​
field_of_study
string
required

The field of study the user studied.

Maximum length: 250
​
country
string
required
​
created_at
string<date-time>
required

The date and time the education entry was created.

​
updated_at
string<date-time>
required

The date and time the education entry was last updated.

​
degree
string | null

The degree the user obtained. (optional)

Maximum length: 250
​
started_from_month
integer | null

Month when the education started (1-12).

Required range: 1 <= x <= 12
​
started_from_year
integer | null

Year when the education started (YYYY).

Required range: 1900 <= x <= 2100
​
finished_at_month
integer | null

Month when the education was completed (1-12).

Required range: 1 <= x <= 12
​
finished_at_year
integer | null

Year when the education was completed (YYYY).

Required range: 1900 <= x <= 2100
​
current
boolean

Whether the user is currently studying. default: False

​
description
string | null

The description of the education entry. User can provide any kind of description for that user. Usually in HTML format to support rich text. (optional)

Maximum length: 3000