ERPNext HRMS icon

ERPNext HRMS

Work with ERPNext/Frappe HRMS v15-v16 documents and methods

Custom DocType → Get

AI-generated

Summary

Retrieve a specific document from a custom DocType in ERPNext HRMS by specifying the document's name.

Inputs

  • API Version — Select the Frappe REST API version ('v1' or 'v2') to use for the request.
  • Custom DocType (required) — The name of the custom DocType to query (e.g., 'Job Applicant').
  • Document Name (required) — The name or ID of the specific document within the custom DocType to retrieve.

Output shape

a single document object from the specified custom DocType

Returns the full data of the document with the given name. Requires the custom DocType and document name inputs. Errors if the document does not exist or inputs are invalid.

Examples

Example 1: Retrieve a Job Applicant document by its unique identifier

Set API Version to 'v1', Custom DocType to 'Job Applicant', and Document Name to the desired document ID.

Links

Discussion