지원자 메모

메모 목록 조회

GET https://api.roundhr.com/v1/candidates/{candidate_code}/memos

지원자의 메모 목록을 반환합니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

응답 예제

{
   "collection": [
      {
         "id": 123,
         "parent_id": null,
         "content": "1차 면접 통과, 기술 역량 우수함",
         "accessible_role": "job_manager",
         "file_url": null,
         "mentions": ["user_code_123"],
         "pinned": true,
         "fixed_at": "2024-09-02T18:56:37+09:00",
         "created_at": "2024-09-02T18:56:37+09:00",
         "updated_at": "2024-09-02T18:56:37+09:00",
         "user": {
            "code": "code_user123",
            "name": "김채용",
            "email": "[email protected]"
         },
         "replies": [
            {
               "id": 124,
               "parent_id": 123,
               "content": "동의합니다. 2차 면접 진행하죠.",
               "accessible_role": "job_manager",
               "file_url": null,
               "mentions": [],
               "pinned": false,
               "fixed_at": null,
               "created_at": "2024-09-03T10:30:00+09:00",
               "updated_at": "2024-09-03T10:30:00+09:00",
               "user": {
                  "code": "code_user456",
                  "name": "이면접",
                  "email": "[email protected]"
               }
            }
         ]
      }
   ]
}

메모 상세 조회

GET https://api.roundhr.com/v1/candidates/{candidate_code}/memos/{id}

메모 상세 정보를 반환합니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

id

integer

required

메모 ID

응답 예제


메모 생성

POST https://api.roundhr.com/v1/candidates/{candidate_code}/memos

새로운 메모를 생성합니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

Body Parameters

Name
Type
필수
Description

content

string

required

메모 내용

parent_id

integer

optional

부모 메모 ID (대댓글인 경우)

file_url

string

optional

첨부 파일 URL

accessible_role

string

optional

열람 권한 (job_admin, job_manager, member)

mentions

array

optional

멘션할 사용자 코드 배열

요청 예제

응답 예제


메모 수정

PATCH https://api.roundhr.com/v1/candidates/{candidate_code}/memos/{id}

기존 메모를 수정합니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

id

integer

required

메모 ID

Body Parameters

Name
Type
필수
Description

content

string

optional

메모 내용

file_url

string

optional

첨부 파일 URL

accessible_role

string

optional

열람 권한 (job_admin, job_manager, member)

mentions

array

optional

멘션할 사용자 코드 배열

요청 예제

응답 예제


메모 삭제

DELETE https://api.roundhr.com/v1/candidates/{candidate_code}/memos/{id}

메모를 삭제합니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

id

integer

required

메모 ID

응답 예제


메모 고정/해제

POST https://api.roundhr.com/v1/candidates/{candidate_code}/memos/{id}/pin

메모를 상단에 고정하거나 고정을 해제합니다. 이미 고정된 메모는 해제되고, 고정되지 않은 메모는 고정됩니다.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Path Parameters

Name
Type
필수
Description

candidate_code

string

required

지원자 고유 코드

id

integer

required

메모 ID

응답 예제


응답 필드 설명

Field
Type
Description

id

integer

메모 고유 ID

parent_id

integer

부모 메모 ID (대댓글인 경우)

content

string

메모 내용

accessible_role

string

열람 권한 (job_admin, job_manager, member)

file_url

string

첨부 파일 URL

mentions

array

멘션된 사용자 코드 배열

pinned

boolean

고정 여부

fixed_at

string

고정 일시 (고정되지 않은 경우 null)

created_at

string

생성 일시

updated_at

string

수정 일시

user

object

작성자 정보

replies

array

대댓글 목록 (목록 조회 시)

accessible_role 값

Value
Description

job_admin

공고 관리자만 열람 가능

job_manager

공고 매니저 이상 열람 가능

member

모든 멤버 열람 가능

Last updated