home
Release NotesRelease ResourcesGeneralDeveloper Hub

general

Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral
search
search
Conga Advantage Platform
Advantage Platform Administration
CPQ
Billing for Advantage PlatformBilling for SalesforceCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceTurboEngines
CLM
Adobe Sign ServicesCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceContractsConga for Google DocsContract Intelligence (Standalone)Discovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformSmart SearchX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager
Document Automation
Approvals for Advantage PlatformApprovals for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceGridInvoice GenerationMix FormsOrchestrateQuote GenerationSign for Advantage PlatformSign for Salesforce

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

search

general

chevron_left

general Contents

close

  • Features by Release

  • Conga Upgrade Program

  • chevron_right

    System Requirements and Supported Platforms Matrix

  • Managed Packages Dependency Matrix

  • Conga Applications in Salesforce Lightning

  • Salesforce Multi-Factor Authentication Support for Conga Commerce

  • chevron_right

    Conga Product Glossary

  • chevron_right

    Conga Upgrade Assistant

  • chevron_right

    Product Retirement Schedule

  • expand_more

    Developer Center

    • chevron_right

      Approvals for Salesforce REST APIs

    • chevron_right

      Billing for Salesforce REST APIs

    • chevron_right

      CLM for Salesforce REST APIs

    • chevron_right

      CPQ for Salesforce REST APIs

    • expand_more

      Digital Commerce for Salesforce REST APIs

      • chevron_right

        CPQ REST API Version 4

      • expand_more

        CPQ REST API Version 5

        • chevron_right

          Authentication

        • chevron_right

          Storefront

        • chevron_right

          Account

        • chevron_right

          PriceList

        • chevron_right

          Catalog

        • chevron_right

          Carts

        • chevron_right

          Cart Items

        • chevron_right

          Favorites

        • expand_more

          Generic

          • Describe Object Metadata

            get

          • Query

            post

          • Get Record(s)

            get

          • Create Record(s)

            post

          • Fetch Single Record

            get

          • Upsert Record(s)

            put

          • Delete Single Record

            delete

          • Delete Multiple Records

            post
        • chevron_right

          Order

        • chevron_right

          Quote

        • chevron_right

          Assets

        • chevron_right

          Collaboration Request

        • chevron_right

          User Views

    • chevron_right

      Discovery AI for Salesforce REST APIs

    • chevron_right

      Orchestrate REST APIs

    • chevron_right

      Partner Commerce for Salesforce REST APIs

    • chevron_right

      TurboEngines REST APIs

    list_altShow Contents

    chevron_left

    General

    Generic

    chevron_right
    download

    Get Record(s)

    get
    /{object}

    Records can be queried from the system by passing in the name of the object as a rest parameter and query conditions can be specified with various query parameters.

    Request

    Security: Basic Auth

    Path Parameters

    object
    string
    required

    Name of the object you want returned.

    Example:
    Apttus_Config2__Order__C

    Query Parameters

    aggregate
    boolean

    True / False to perform the query as an aggregate.

    Example:
    true
    alias
    boolean

    The namespace for the fields is prefixed if set to False. By default it is True.

    Example:
    false
    children
    string

    CSV of child data to include in result.

    Example:
    children=StoreBanners
    condition[0]
    string

    Array of conditions.

    Example:
    condition[0]=Id,Equal,a1I3I000000e7GLUAY
    fieldList
    string

    List of fields to return.

    Example:
    Account
    groupBy
    string

    CSV of fields to group the results by.

    Example:
    CSV
    lookups
    string

    Accepts primitive value.

    Example:
    lookups=AccountId
    page[current]
    number

    Page of records to display.

    Example:
    1
    page[limit]
    number

    Maximum number of records to return.

    Example:
    10
    searchString
    string

    The search string to apply.

    Example:
    Auto
    sort[direction]
    string

    ASC / DESC

    Example:
    ASC
    sort[field]
    string

    Field to sort by.

    Example:
    <string>

    Headers

    x-account
    string

    The account value from the header is taken as default account if passed as query parameter.

    Example:
    0011900000hnGsr
    x-storefront
    string
    required

    The name of the storefront used for the request.

    Example:
    ECommerce

    Responses

    200

    OK

    Body

    responses
    /
    200
    Id
    string
    Name
    string
    Data
    array[object]
    Auth
    Username
    :
    Password
    :
    Parameters
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    :
    curl --request GET \
      --url https://documentation.conga.com/object \
      --header 'Accept: application/json' \
      --header 'Authorization: Basic 123' \
      --header 'x-account: ' \
      --header 'x-storefront: '
    Response Example
    1
    {
    2
      "title": "success",
    3
      "status": 200,
    4
      "data": [
    5
        {
    6
          "ShowTabView": false,
    7
          "Version": 1,
    8
          "ExcludeFromSitemap": false,
    9
          "Uom": "Each",
    10
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057rzq\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1FEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    11
          "IconSize": "225x225",
    12
          "IconId": "00P190000025e1FEAQ",
    13
          "HasSearchAttributes": false,
    14
          "HasOptions": false,
    15
          "HasDefaults": false,
    16
          "HasAttributes": true,
    17
          "Customizable": false,
    18
          "ConfigurationType": "Standalone",
    19
          "IsArchived": false,
    20
          "IsDeleted": false,
    21
          "CurrencyIsoCode": "EUR",
    22
          "Family": "Equipment",
    23
          "SystemModstamp": "2019-06-19T07:00:11.000Z",
    24
          "LastModifiedById": "00550000000vtlpAAA",
    25
          "LastModifiedDate": "2019-06-19T07:00:11.000Z",
    26
          "CreatedById": "00550000000vtlpAAA",
    27
          "CreatedDate": "2019-05-27T11:14:33.000Z",
    28
          "IsActive": true,
    29
          "ProductCode": "PM-01",
    30
          "Name": "Powermill",
    31
          "Id": "01t190000057rzqAAA"
    32
        },
    33
        {
    34
          "ShowTabView": false,
    35
          "Version": 1,
    36
          "ExcludeFromSitemap": false,
    37
          "Uom": "Each",
    38
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057s6Q\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e4MEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    39
          "IconId": "00P190000025e4MEAQ",
    40
          "HasSearchAttributes": false,
    41
          "HasOptions": false,
    42
          "HasDefaults": false,
    43
          "HasAttributes": false,
    44
          "Customizable": false,
    45
          "ConfigurationType": "Standalone",
    46
          "IsArchived": false,
    47
          "IsDeleted": false,
    48
          "CurrencyIsoCode": "USD",
    49
          "Family": "Equipment",
    50
          "SystemModstamp": "2019-06-19T08:40:58.000Z",
    51
          "LastModifiedById": "00550000000vtlpAAA",
    52
          "LastModifiedDate": "2019-06-19T08:40:58.000Z",
    53
          "CreatedById": "00550000000vtlpAAA",
    54
          "CreatedDate": "2019-05-28T12:39:32.000Z",
    55
          "IsActive": true,
    56
          "ProductCode": "PM-02",
    57
          "Name": "Powermill 2",
    58
          "Id": "01t190000057s6QAAQ"
    59
        },
    60
        {
    61
          "ShowTabView": false,
    62
          "Version": 1,
    63
          "ExcludeFromSitemap": false,
    64
          "Uom": "Each",
    65
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGZ\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1DEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    66
          "IconSize": "183x275",
    67
          "IconId": "00P190000025e1DEAQ",
    68
          "HasSearchAttributes": false,
    69
          "HasOptions": true,
    70
          "HasDefaults": false,
    71
          "HasAttributes": true,
    72
          "Customizable": false,
    73
          "ConfigurationType": "Bundle",
    74
          "IsArchived": false,
    75
          "IsDeleted": false,
    76
          "CurrencyIsoCode": "USD",
    77
          "Family": "Hardware",
    78
          "SystemModstamp": "2019-06-19T06:57:44.000Z",
    79
          "LastModifiedById": "00550000000vtlpAAA",
    80
          "LastModifiedDate": "2019-06-19T06:57:44.000Z",
    81
          "CreatedById": "00550000000vtlpAAA",
    82
          "CreatedDate": "2019-06-01T16:16:48.000Z",
    83
          "IsActive": true,
    84
          "Description": "A rake is a broom for outside use; a horticultural implement consisting of a toothed bar fixed transversely to a handle, or tines fixed to a handle, and used to collect leaves, hay, grass, etc",
    85
          "ProductCode": "RS01",
    86
          "Name": "Rakes",
    87
          "Id": "01t190000057uGZAAY"
    88
        },
    89
        {
    90
          "ShowTabView": false,
    91
          "Version": 1,
    92
          "ExcludeFromSitemap": false,
    93
          "Uom": "Each",
    94
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGe\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e4REAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    95
          "IconSize": "225x225",
    96
          "IconId": "00P190000025e4REAQ",
    97
          "HasSearchAttributes": false,
    98
          "HasOptions": false,
    99
          "HasDefaults": false,
    100
          "HasAttributes": true,
    101
          "Customizable": false,
    102
          "ConfigurationType": "Option",
    103
          "IsArchived": false,
    104
          "IsDeleted": false,
    105
          "CurrencyIsoCode": "USD",
    106
          "Family": "Hardware",
    107
          "SystemModstamp": "2019-07-15T18:07:30.000Z",
    108
          "LastModifiedById": "00550000000vtlpAAA",
    109
          "LastModifiedDate": "2019-07-15T18:07:30.000Z",
    110
          "CreatedById": "00550000000vtlpAAA",
    111
          "CreatedDate": "2019-06-01T16:24:31.000Z",
    112
          "IsActive": true,
    113
          "Description": "his is the rake that most readily comes to mind when you hear the word rake and think about falling leaves.\n\nRead more at Gardening Know How: What Are Rakes Used For: Different Kinds Of Rakes For Gardening https://www.gardeningknowhow.com/garden-how-to/tools/different-rakes-for-gardening.htm",
    114
          "ProductCode": "RS-L",
    115
          "Name": "Lawn Rake",
    116
          "Id": "01t190000057uGeAAI"
    117
        },
    118
        {
    119
          "ShowTabView": false,
    120
          "Version": 1,
    121
          "ExcludeFromSitemap": false,
    122
          "Uom": "Each",
    123
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGj\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1SEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    124
          "IconSize": "225x225",
    125
          "IconId": "00P190000025e1SEAQ",
    126
          "HasSearchAttributes": false,
    127
          "HasOptions": false,
    128
          "HasDefaults": false,
    129
          "HasAttributes": false,
    130
          "Customizable": false,
    131
          "ConfigurationType": "Option",
    132
          "IsArchived": false,
    133
          "IsDeleted": false,
    134
          "CurrencyIsoCode": "USD",
    135
          "Family": "Hardware",
    136
          "SystemModstamp": "2019-06-19T06:58:57.000Z",
    137
          "LastModifiedById": "00550000000vtlpAAA",
    138
          "LastModifiedDate": "2019-06-19T06:58:57.000Z",
    139
          "CreatedById": "00550000000vtlpAAA",
    140
          "CreatedDate": "2019-06-01T16:37:44.000Z",
    141
          "IsActive": true,
    142
          "Description": "This rake is more heavy duty. Its tines are wide-set and short, usually only about 3 inches (7.5 cm.) long\n\nRead more at Gardening Know How: What Are Rakes Used For: Different Kinds Of Rakes For Gardening https://www.gardeningknowhow.com/garden-how-to/tools/different-rakes-for-gardening.htm",
    143
          "ProductCode": "RS-BR",
    144
          "Name": "Bow Rake",
    145
          "Id": "01t190000057uGjAAI"
    146
        },
    147
        {
    148
          "ShowTabView": false,
    149
          "Version": 1,
    150
          "ExcludeFromSitemap": false,
    151
          "Uom": "Each",
    152
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGo\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1NEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    153
          "IconSize": "171x295",
    154
          "IconId": "00P190000025e1NEAQ",
    155
          "HasSearchAttributes": false,
    156
          "HasOptions": false,
    157
          "HasDefaults": false,
    158
          "HasAttributes": false,
    159
          "Customizable": false,
    160
          "ConfigurationType": "Option",
    161
          "IsArchived": false,
    162
          "IsDeleted": false,
    163
          "CurrencyIsoCode": "USD",
    164
          "Family": "Hardware",
    165
          "SystemModstamp": "2019-06-19T06:58:31.000Z",
    166
          "LastModifiedById": "00550000000vtlpAAA",
    167
          "LastModifiedDate": "2019-06-19T06:58:31.000Z",
    168
          "CreatedById": "00550000000vtlpAAA",
    169
          "CreatedDate": "2019-06-01T16:39:58.000Z",
    170
          "IsActive": true,
    171
          "Description": "This is almost the same as a leaf rake, except that it’s much narrower. It’s more easily handled and fits better into small places, like under shrubs (hence the name), to rake up leaves and other litter.\n\nRead more at Gardening Know How: What Are Rakes Used For: Different Kinds Of Rakes For Gardening https://www.gardeningknowhow.com/garden-how-to/tools/different-rakes-for-gardening.htm",
    172
          "ProductCode": "RS-S",
    173
          "Name": "Shrub Rake",
    174
          "Id": "01t190000057uGoAAI"
    175
        },
    176
        {
    177
          "ShowTabView": false,
    178
          "Version": 1,
    179
          "ExcludeFromSitemap": false,
    180
          "Uom": "Each",
    181
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGt\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1IEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    182
          "IconSize": "225x225",
    183
          "IconId": "00P190000025e1IEAQ",
    184
          "HasSearchAttributes": false,
    185
          "HasOptions": false,
    186
          "HasDefaults": false,
    187
          "HasAttributes": false,
    188
          "Customizable": false,
    189
          "ConfigurationType": "Option",
    190
          "IsArchived": false,
    191
          "IsDeleted": false,
    192
          "CurrencyIsoCode": "USD",
    193
          "Family": "Hardware",
    194
          "SystemModstamp": "2019-06-19T06:58:15.000Z",
    195
          "LastModifiedById": "00550000000vtlpAAA",
    196
          "LastModifiedDate": "2019-06-19T06:58:15.000Z",
    197
          "CreatedById": "00550000000vtlpAAA",
    198
          "CreatedDate": "2019-06-01T16:41:30.000Z",
    199
          "IsActive": true,
    200
          "Description": "This is a small, handheld rake that’s about the size of a trowel.\n\nRead more at Gardening Know How: What Are Rakes Used For: Different Kinds Of Rakes For Gardening https://www.gardeningknowhow.com/garden-how-to/tools/different-rakes-for-gardening.htm",
    201
          "ProductCode": "RS-H",
    202
          "Name": "Hand Rake",
    203
          "Id": "01t190000057uGtAAI"
    204
        },
    205
        {
    206
          "ShowTabView": false,
    207
          "Version": 1,
    208
          "ExcludeFromSitemap": false,
    209
          "Uom": "Each",
    210
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uGy\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e1EEAQ\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    211
          "IconSize": "225x225",
    212
          "IconId": "00P190000025e1EEAQ",
    213
          "HasSearchAttributes": false,
    214
          "HasOptions": false,
    215
          "HasDefaults": false,
    216
          "HasAttributes": false,
    217
          "Customizable": false,
    218
          "ConfigurationType": "Standalone",
    219
          "IsArchived": false,
    220
          "IsDeleted": false,
    221
          "CurrencyIsoCode": "USD",
    222
          "Family": "Hardware",
    223
          "SystemModstamp": "2019-06-19T06:58:00.000Z",
    224
          "LastModifiedById": "00550000000vtlpAAA",
    225
          "LastModifiedDate": "2019-06-19T06:58:00.000Z",
    226
          "CreatedById": "00550000000vtlpAAA",
    227
          "CreatedDate": "2019-06-01T16:43:06.000Z",
    228
          "IsActive": true,
    229
          "Description": "This mean looking rake is a bit like a bow rake with blades on either end\n\nRead more at Gardening Know How: What Are Rakes Used For: Different Kinds Of Rakes For Gardening https://www.gardeningknowhow.com/garden-how-to/tools/different-rakes-for-gardening.htm",
    230
          "ProductCode": "RS-TR",
    231
          "Name": "Thatch Rake",
    232
          "Id": "01t190000057uGyAAI"
    233
        },
    234
        {
    235
          "ShowTabView": false,
    236
          "Version": 1,
    237
          "ExcludeFromSitemap": false,
    238
          "Uom": "Each",
    239
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uK2\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e18EAA\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    240
          "IconSize": "225x225",
    241
          "IconId": "00P190000025e18EAA",
    242
          "HasSearchAttributes": false,
    243
          "HasOptions": false,
    244
          "HasDefaults": false,
    245
          "HasAttributes": true,
    246
          "Customizable": false,
    247
          "ConfigurationType": "Standalone",
    248
          "IsArchived": false,
    249
          "IsDeleted": false,
    250
          "CurrencyIsoCode": "USD",
    251
          "Family": "Hardware",
    252
          "SystemModstamp": "2019-06-19T06:57:19.000Z",
    253
          "LastModifiedById": "00550000000vtlpAAA",
    254
          "LastModifiedDate": "2019-06-19T06:57:19.000Z",
    255
          "CreatedById": "00550000000vtlpAAA",
    256
          "CreatedDate": "2019-06-03T05:10:23.000Z",
    257
          "IsActive": true,
    258
          "Description": "A modern day hammer is a tool consisting of a weighted \"head\" fixed to a long handle that is swung to deliver an impact to a small area of an object.",
    259
          "ProductCode": "HM-01",
    260
          "Name": "Hammer",
    261
          "Id": "01t190000057uK2AAI"
    262
        },
    263
        {
    264
          "ShowTabView": false,
    265
          "Version": 1,
    266
          "ExcludeFromSitemap": false,
    267
          "Uom": "Each",
    268
          "Icon": "<a href=\"/apex/Apttus_Config2__IconUploader?productId=01t190000057uK7\" target=\"_top\"><img src=\"/servlet/servlet.FileDownload?file=00P190000025e13EAA\" alt=\"Icon\" style=\"height:50px; width:50px;\" border=\"0\"/></a>",
    269
          "IconSize": "225x225",
    270
          "IconId": "00P190000025e13EAA",
    271
          "HasSearchAttributes": false,
    272
          "HasOptions": false,
    273
          "HasDefaults": false,
    274
          "HasAttributes": true,
    275
          "Customizable": false,
    276
          "ConfigurationType": "Standalone",
    277
          "IsArchived": false,
    278
          "IsDeleted": false,
    279
          "CurrencyIsoCode": "USD",
    280
          "Family": "Hardware",
    281
          "SystemModstamp": "2019-06-19T06:57:04.000Z",
    282
          "LastModifiedById": "00550000000vtlpAAA",
    283
          "LastModifiedDate": "2019-06-19T06:57:04.000Z",
    284
          "CreatedById": "00550000000vtlpAAA",
    285
          "CreatedDate": "2019-06-03T05:17:31.000Z",
    286
          "IsActive": true,
    287
          "Description": "A saw is a tool consisting of a tough blade, wire, or chain with a hard toothed edge.",
    288
          "ProductCode": "SW-01",
    289
          "Name": "Saw",
    290
          "Id": "01t190000057uK7AAI"
    291
        }
    292
      ]
    293
    }
    chevron_leftchevron_right
    chevron_right

    Footer Section

    Explore


    Conga.com
    Legal
    Feedback
    Contact Support

    Copyright © 2025 Conga Corporation • All Rights Reserved

    Cookie Notice

    We use cookies to improve your experience on our site. To find out more, read our cookie policy.