MENU
      Get glossary list
        • PDF

        Get glossary list

        • PDF

        Article summary

        Available in Classic and VPC

        Get the list of glossaries.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET-

        Request headers

        For information about the headers common to all Papago Translation APIs, see Common Papago Translation headers.

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        currentPageIntegerRequiredCurrent page number
        pageSizeIntegerRequiredNumber of glossary outputs per page
        • Maximum value: 30

        Request example

        The request example is as follows:

        curl --location --request GET 'https://papago.apigw.ntruss.com/glossary/v1/
        ?currentPage=1
        &pageSize=20' \
        --header 'x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}' \
        --header 'x-ncp-iam-access-key: {x-ncp-iam-access-key}' \
        --header 'x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        dataArray-Glossary list query details
        currentPageString-Current page number
        totalPageInteger-Total number of pages
        currentGlossaryCountInteger-Number of glossaries on current page
        totalGlossaryCountInteger-Total number of glossaries

        data

        The following describes data.

        FieldTypeRequiredDescription
        glossaryKeyString-Glossary ID
        glossaryNameString-Glossary name
        wordCountInteger-Total number of terms in glossary
        descriptionString-Glossary description
        createdDateTimeInteger-Glossary creation date and time (timestamp)
        updatedDateTimeInteger-Glossary last update date and time (timestamp)

        Response status codes

        For information about the HTTP status codes common to all Papago Translation APIs, see Common Papago Translation response status codes.

        Response example

        The response example is as follows:

        {
            "data": [
                {
                    "glossaryKey": "{glossaryKey}",
                    "glossaryName": "GlossaryTest1",
                    "wordCount": 6,
                    "description": "This is a description of the GlossaryTest1 glossary.",
                    "createdDateTime": 1724209126000,
                    "updatedDateTime": 1724216780000
                }
            ],
            "currentPage": 1,
            "totalPage": 1,
            "currentGlossaryCount": 1,
            "totalGlossaryCount": 1
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.