Jump to Content
Product Documentation
Conga Community
Home
API Reference
Product Documentation
Conga Community
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
API Reference
Get all locales
Search
JUMP TO
Overview
About Conga Advantage Platform
REST API Introduction
Authentication
User Management
User Admin
Create a user
post
Get all users
get
Create multiple users
post
Update multiple users
patch
Update a user
patch
Deactivate a user
delete
Get user details by user ID
get
Upload users
post
Clone a user
post
Restore a deactivated user
put
Get CSV format for user upload
get
Get a user's role
get
Check if a user is assigned a role
get
Update a user's role
put
Assign permission group to a user
put
Delete permission groups from a user
delete
Re-send welcome email to new user
post
Get integration user's client ID
get
Generate integration user secret
patch
User Group
Create a user group
post
Get filtered user groups
get
Update a user group
put
Delete a user group
delete
Get user group details by user group ID
get
User Group Member
Create a user group member
post
Delete a user group member
delete
Get all user group members
get
Get user group member details by user group member ID
get
Role Admin
Create a new role
post
Get all roles
get
Create multiple roles
post
Update a role
put
Delete a role
delete
Get role information by ID
get
Check whether the role exists
get
Assign permission groups to a role
put
Delete permission groups from a role
delete
Clone a role
post
Assign admin permissions to a role
put
Delete admin permissions from a role
delete
Admin Permissions
Get the master list of admin permissions
get
Permission Groups
Get the master list of permission groups
get
Add permission group names to the master list
post
Delete permission groups
delete
Clone the permission group
post
Organization
Update organizational information
patch
Get an organization's information
get
Get the locale
get
Get the time zone
get
Get the currency type
get
Organization External Integration
Add external identifiers
post
Remove external identifiers
delete
Get external identifiers
get
Update external identifiers
put
Get all identity providers (IDPs)
get
Add an external identifier
post
Update external identifiers
put
Delete external identifiers
delete
Get external identifiers
get
Update external identifiers
patch
API Connections
Add API connection
post
Update API connection
put
Get API connections
get
Get all API connections
get
Update API connection status
put
Guest User
Create a guest user
post
Update a guest user
put
Deactivate a guest user
delete
Restore a deactivated guest user
put
Field Permission
Set field permissions
post
Get the field permission details by object and permission group name
get
Update a field permission for a given permission group and object
put
Delete a field permission by permission group and object
delete
Set multiple field permissions
post
Get the field permission details by ID
get
Update a field permission
put
Delete a field permission by ID
delete
Object Permission
Create a new object permission
post
Get all object permissions
get
Create multiple object permissions
post
Delete multiple object permission records
delete
Get object permission details by ID
get
Update an object permission
put
Delete an object permission
delete
Validate object action permission
get
Get object permission details by object name
get
Record Type Permission
Set a record type's permission
post
Update a record type's permission for a given permission group and object
put
Set multiple record type permissions
post
Get the record type permission details by object and permission group name
get
Delete a record type's permission by permission group and object
delete
Get the record type permission details by ID
get
Update a record type's permission
put
Delete a record type's permission by ID
delete
Action Permissions
Get all action permissions
get
User
Get logged-in user information
get
Get logged-in user's locale
get
Get logged-in user's time zone
get
Get logged-in user's currency
get
Get logged-in user's currency format
get
Get all action permissions
get
Get action permissions by ObjectName
get
Get Bulk action permissions
post
Get record type permission details by ObjectName
get
Get field permission details by ObjectName
get
Get field permission details for a given field of the given Object Name.
get
Get users with full access on objects passed as input.
get
Timezone and Locale
Get all time zones
get
Get all locales
get
Get all decimal symbols from locales
get
Get all digit grouping symbols from locales
get
Get all long date formats from locales
get
Get all short date formats from locales
get
Get all time formats from locales
get
Get all digit groups from locales
get
Get all negative number formats from locales
get
Currency Format
Get all currency formats
get
Grant Login
Create a Grant Login Request
post
Get all Grant Login Requests
get
Cancel Grant Login Request
put
Get the grant login details by ID
get
Get Access durations
get
Schema Manager
Object Definition
Define a new object schema
post
List all object names
get
Update a schema definition
put
Get a schema definition
get
Set an object's shared status
put
Deprecate an object
patch
Import custom schema
post
Validates lookUpCriteria with respect to lookupObjectName
post
Field Definition
Create a field definition for an object
post
Delete a custom field definition
delete
Update an object's field definition
put
Set the field to deprecate
patch
Validate formula field expression
post
Get the list of formula functions
get
Index Definition
Index a field
post
Delete an existing index
delete
Picklist Definition
Create a new picklist
post
Update a picklist
put
Create a new picklist entry
post
Update a picklist entry by value
put
Create picklist entries by value
post
Update picklist entries by value
put
Dependent Picklist Definition
Get the dependent picklist
get
Create a new dependent picklist mapping
post
Update the dependent picklist
put
Delete the dependent picklist
delete
RecordType Definition
Create a record type picklist entry
post
Update record type picklist entries
put
Complex Field Definition
Create new complex field metadata
post
Create a new complex field
post
Update an object's complex field definition
put
Create complex fields
post
Object Definition Translation
Define the translation
post
Update translation
put
Get translation
get
Delete translations
delete
Object Metadata
Get a schema definition
get
Export custom schema
post
Get all dependencies
get
Get all references
get
Get field metadata
get
Get field dependencies
get
Get the dependent picklist definition
get
Get all scoped object names.
get
Data
Custom Object
Insert a new custom object record
post
Get all custom object records
get
Get a custom object record
get
Update a custom object record
put
Delete a custom object record
delete
Insert custom object records
post
Update custom object records
put
Delete custom object records
delete
Upsert custom object records
patch
Update custom object records as per the criteria
put
Delete custom object records as per the criteria
delete
Execute multiple queries
post
Execute single query
post
Get all record types for the custom object
get
Currency
Get all currency
get
Record Share
Share a record
post
Update a shared record's access level
put
Un-share a record
delete
Get a record's sharing information
get
Get a record's sharing status
get
Get a user's access details for a shared record
get
Account
Insert a new account record
post
Get all account records
get
Get a account record using account record ID
get
Update a account record
put
Delete a account record
delete
Insert multiple account records
post
Update multiple account records
put
Delete multiple account records
delete
Upsert multiple account records
patch
Execute single query
post
Get all account record types
get
Contact
Insert a new contact record
post
Get all contact records
get
Get a contact record using contact record ID
get
Update a contact record
put
Delete a contact record
delete
Insert multiple contact records
post
Update multiple contact records
put
Delete multiple contact records
delete
Upsert multiple contact records
patch
Execute single query
post
Get all contact record types
get
Opportunity
Insert a new opportunity record
post
Get all opportunity records
get
Get a opportunity record using opportunity record ID
get
Update a opportunity record
put
Delete a opportunity record
delete
Insert multiple opportunity records
post
Update multiple opportunity records
put
Delete multiple opportunity records
delete
Upsert multiple opportunity records
patch
Execute single query
post
Get all opportunity record types
get
Document Management
Documents
Upload documents
post
Delete documents by their IDs
delete
Upload a single document
post
Initiate a multipart upload
post
Upload a single part of a large file
put
Complete multipart upload
post
Abort a multipart upload
delete
Update a document
put
Delete a document by its ID
delete
Get document information by its ID
get
Update the document metadata information for all versions
put
Get a document's metadata by its ID
get
Get a document by its ID
get
Get documents by their IDs
get
Delete documents by object type and ID
delete
Get documents by object type and ID
get
Get version details by object type and ID
get
Clone a document
post
Check a document
get
Retrieve document versions
get
Get a document by its ID and version
get
Delete a versioned document
delete
Search documents
post
Get documents by object ID and file type
get
Configuration Management
Configuration
Add a configuration
post
Update a configuration
put
Delete a configuration
delete
Get a configuration
get
Get multiple configurations
post
Get configurations by category
get
Export custom configuration
post
Import custom configuration
post
Get configuration categories
get
Localization
Translation Admin
Get a localized value
get
Delete the translation value
delete
Get locales where translations are defined
get
Search for translation
post
Get translations by Locale and Module
get
Delete translation values
delete
Export CSV with default locale (en-US)
post
Import translation CSV
post
Add translation value
post
Insert multiple translations
post
Update the translation value
put
Retrieve all modules
get
Add translation module
post
Delete translation module
delete
Translation Runtime
Get translated value for the user's locale
get
Get translated values for the user's locale
post
Get translated values with parameters for the user's locale
post
Get translated value and user locale
get
Email
Email Template
Render an email template
post
Render an unsaved email template
post
Create an email template
post
Get the list of email templates
get
Create a template attachment for a given template ID
post
Get an email template by ID
get
Update an email template
put
Delete an email template
delete
Delete a template attachment for a given template ID
delete
Delete all template attachments for a given template id at once
delete
Get the list of email templates
get
Clone the email template
post
Email Template Category
Create an email template category
post
Get the list of email template categories
get
Get an email template category by ID
get
Update an email template category
put
Delete the email template category
delete
Email Sender
Send an email
post
Send bulk/mass email
post
Extensibility
Custom Code
Retrieve custom code by project name
get
Delete a custom code by name
delete
Enable debug log
post
Get all custom codes
get
Execute the custom code
post
Download the project
get
Export the Projects or Resources based on the specified Type
post
Import the Projects or Resources based on the specified Type
post
Add a trusted API configuration
post
Get all trusted API configurations
get
Update a trusted API configuration
put
Delete a trusted API configuration
delete
Retrieve a trusted API configuration by name
get
Retrieve a trusted API configuration by URI
get
Retrieve all allowed HTTP verbs
get
Add a trusted object configuration
post
List all trusted object configurations
get
Update a trusted object configuration
put
Delete a trusted object configuration
delete
Get a trusted object configuration by name
get
List allowed operations
get
Callback
Update callback contract mapping
put
Get all callback contracts
get
Get callback contract details
get
Get callback custom code setting configuration
get
Upsert callback custom code setting configuration
put
Get all modules
get
Get all callback contracts by module name
get
Conga Hooks
Retrieve a data change rule by name
get
Update a data change rule
put
Delete a data change rule
delete
Insert a new data change rule
post
Retrieve all data change rules
get
Retrieve all supported event types in service hook rules
get
Get ServiceHooks cancellation token setting configuration
get
Upsert ServiceHooks cancellation token setting configuration
put
API Resource
Resolve a URI
post
Create a new API resource
post
Get all API resources
get
Get API resource information by resource name
get
Delete an API resource
delete
Clone an API resource
post
Create an API resource URI
post
Get URIs by name or verb
get
Update URI entry information
put
Delete a URI
delete
Get CustomAPI cancellation token setting configuration
get
Upsert CustomAPI cancellation token setting configuration
put
Conga Hooks Rules
Retrieve a Service Hooks rule by name
get
Update a Service Hooks rule
patch
Delete a Service Hooks rule
delete
Create a new Service Hooks rule
post
Retrieve all Service Hooks rules
get
Retrieve all supported event types in service hook rules
get
Get ServiceHooks cancellation token setting configuration
get
Upsert ServiceHooks cancellation token setting configuration
put
Package Deployment
Deploy source artifact package
post
Track package deployment status
get
Retrieve all data of deployment package history
get
Retrieve resource deployment information for the specified package
get
Retrieve package information for the specified package
get
Revert a custom code deployment package with given name
post
Get package deployment logs
get
Search
Search Admin
Get search setting
get
Get all search settings
get
Create a search setting
post
Update object search setting
put
Delete object search setting
delete
Index a document
post
Get the data sync status of an object
get
Get the data sync status of all objects
get
Resync data for objects except Document
post
Resync data for an object
post
Search Runtime
Search an object
post
Get Elastic search Query
post
Search documents
post
Search objects
post
Retrieve fields from the search settings or database
get
Get a list of objects for which the search setting is enabled
get
Scheduler
Scheduler
List scheduled jobs
get
Get scheduled job details
get
Delete a scheduled job
delete
Create a new cron scheduled job
post
Create a one-time scheduled job
post
Execute the scheduled job
post
Update the scheduled job
put
Disable the scheduled job
put
Enable scheduled job
put
Get scheduled job execution history
get
Export a scheduled job
get
Export all scheduled jobs
post
Create or update scheduled jobs by organization
post
Conversion Management
Currency Admin
Retrieve a currency rate by ID
get
Update a currency rate
put
Delete currency rate by ID
delete
Add a new currency rate
post
Get all currency rates
get
Add multiple currency rates
post
Update multiple currency rates
put
Currency Runtime
Retrieve effective currency rate
post
Retrieve effective currency rates
post
Retrieve converted currency
post
Frequency Conversion Admin
Retrieve a frequency conversion rate by ID
get
Update a frequency conversion rate
put
Delete frequency conversion rate by ID
delete
Get all frequency conversion rates
get
Add a new frequency conversion rate
post
Add multiple Frequency conversion rates
post
Update multiple frequency conversion rates
put
Frequency Conversion Runtime
Retrieve effective frequency Conversion rate
post
UOM Conversion Admin
Retrieve a UOM conversion rate by ID
get
Update a UOM conversion rate
put
Delete UOM conversion rate by ID
delete
Get all UOM conversion rates
get
Add a new UOM conversion rate
post
Add multiple UOM conversion rates
post
Update multiple UOM conversion rates
put
UOM Conversion Runtime
Retrieve effective UOM conversion rate
post
File Store
File Store
Download a file using the specified file path and file name
get
Provide time-based public access to a file
post
Download multiple files as a ZIP archive
get
Retrieve list of file names from a specified path in the file store
get
Retrieve detailed information about a specific file in the file store
get
Check if a file exists in the file store
get
Upload a file to the file store with specified metadata and settings
post
Upload multiple files
post
Delete multiple files from the file store
delete
Delete a file from the file store
delete
Delete all files in a specified folder location
delete
Initiate a multipart upload process for a large file
post
Upload a single part of a large file in a multipart upload process
put
Abort an incomplete multipart upload process
delete
Complete a multipart upload process by combining all uploaded parts into the final file
post
Retrieve file size limitation information
get
Create a new folder in the file store at the specified path
post
Get all contents of a given folder
post
CDN Store
Get the file from the CDN store
get
Upload a file(upto 100 MB) to the CDN store
post
Delete a file
delete
Delete multiple files
delete
Audit
Field History Tracking
Get audit history for a record
post
Field History Tracking Config
Adds a list of fields to an object in the field history tracking configuration.
put
Removes the object and all its fields from the field history tracking configuration.
delete
Get objects and its fields set for field history tracking.
get
Get all locales
get
https://rls.congacloud.com/api/user-management/v1/locales
Retrieves all locales.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
Log in to use your API keys
URL
Base URL
https://rls.congacloud.com
/api/user-management/v1/locales
RESPONSE
Click
Try It!
to start a request and see the response here!