Conga Object Definition API

openapi: 3.2.0
info:
  title: Schema Manager Object Definition API
  version: v1
servers:
- url: https://rls.congacloud.com
- url: https://preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: Object Definition
paths:
  /api/schema/v1/objects:
    get:
      tags:
      - Object Definition
      summary: List all object names
      description: Fetches and lists all metadata and returns `OK` when the request is executed.
      parameters:
      - name: sortField
        in: query
        description: Field name for sorting
        schema:
          type: string
      - name: sortDirection
        in: query
        description: Sort direction (ascending or descending) of the data in sortField.
        schema:
          $ref: '#/components/schemas/SortDirection'
      - name: pageSize
        in: query
        description: The number of records to display on each page
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: The page number of the result set to view
        schema:
          type: integer
          format: int32
      - name: startsWithFilter
        in: query
        description: Filter to fetch only names starting with this string.
        schema:
          type: string
      - name: objectType
        in: query
        description: Filter to fetch objects based on their object type.
        schema:
          $ref: '#/components/schemas/ObjectTypeFilter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectInfoListAPIResponse'
              example:
                Success: true
                Data:
                - Name: Currency
                  DisplayName: Currency
                  Description: Currency
                  Category: Platform
                  IsProtected: true
                  IsDeprecated: false
                  ObjectType: Default
                - Name: Role
                  DisplayName: Role
                  Description: Role
                  Category: Platform
                  IsProtected: true
                  IsDeprecated: false
                  ObjectType: Default
                - Name: ObjectPermission
                  DisplayName: ObjectPermission
                  Description: ObjectPermission
                  Category: Platform
                  IsProtected: true
                  IsDeprecated: false
                  ObjectType: Default
                - Name: Agreement_UserShare_p
                  DisplayName: Agreement_UserShare_p
                  Description: Agreement_UserShare_p
                  Category: Platform
                  IsProtected: true
                  IsDeprecated: false
                  ObjectType: Default
                StatusCode: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: getApiSchemaV1Objects
      x-operation-id-source: derived
    post:
      tags:
      - Object Definition
      summary: Define a new object schema
      description: Validates and creates an object schema definition.
      requestBody:
        description: Request to create object schema definition
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectMetadataAPIResponse'
              example:
                Success: true
                Data:
                  Name: Account
                  DisplayName: Account
                  Description: Account
                  IsProtected: true
                  IsDeprecated: false
                  IsShared: true
                  IsDataCacheEnabled: true
                  IsTrackingEnabled: true
                  IsAllowOwnerScope: false
                  Category: Common
                  ObjectType: Default
                  IsRecycleBinEnabled: false
                  FieldMetadata:
                  - FieldName: Name
                    DisplayName: Name
                    Description: null
                    DataType: String
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: false
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  - FieldName: Id
                    DisplayName: Id
                    Description: null
                    DataType: Identifier
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: true
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  InternalRuntimeAliasFields: []
                  InternalPrecomputedAliasFields: []
                  PicklistMetadata: []
                  DependentPicklistMetadata: []
                  ComplexFieldMetadata: []
                  AliasFieldMetadata: []
                  IndexMetadata: []
                  TtlFieldMetadata: null
                  CreatedBy:
                    Id: c3213a44-7ad0-4361-8b6d-bce0f1cee228
                    Name: System Admin
                  CreatedDate: '2026-08-14T00:04:01.194+00:00'
                  ModifiedBy:
                    Id: f1c6dc48-76fb-4bcd-94bb-2444ce659760
                    Name: System Admin
                  ModifiedDate: '2026-08-14T00:04:01.194+00:00'
                  Attributes:
                    PublishDataChangeEvents: true
                    TrackAuditHistory: true
                    IsInternalObject: false
                StatusCode: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: postApiSchemaV1Objects
      x-operation-id-source: derived
  /api/schema/v1/objects/customschema/import:
    post:
      tags:
      - Object Definition
      summary: Import custom schema
      description: 'Imports schema for custom fields and custom objects.


        For standard object: Creates missing custom fields from the corresponding JSON file (part of the ZIP file).


        For custom object: If a custom object is not available, it is created with all the fields; otherwise, it creates missing custom fields from the corresponding JSON file (part of the ZIP file).'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringStringDictionaryAPIResponse'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: postApiSchemaV1ObjectsCustomschemaImport
      x-operation-id-source: derived
  /api/schema/v1/objects/{lookupObjectName}/lookup-criteria/validate:
    post:
      tags:
      - Object Definition
      summary: Validate lookup criteria
      description: Validates the provided lookup criteria against the schema of the specified lookup object.
      parameters:
      - name: lookupObjectName
        in: path
        description: The name of the object for which the lookup criteria should be validated. Must be a valid, existing object.
        required: true
        schema:
          type: string
      requestBody:
        description: The criteria string to validate. Must be non-empty and use supported syntax for field references and operators.
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringStringDictionaryAPIResponse'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: postApiSchemaV1ObjectsByLookupObjectNameLookupCriteriaValidate
      x-operation-id-source: derived
  /api/schema/v1/objects/{objectName}:
    get:
      tags:
      - Object Definition
      summary: Get a translated schema definition
      description: Validates and fetches a given object's schema definition.
      parameters:
      - name: objectName
        in: path
        description: Name of the object
        required: true
        schema:
          type: string
      - name: locale
        in: query
        description: Optional parameter, name of the organization supported locale
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectMetadataAPIResponse'
              example:
                Success: true
                Data:
                  Name: Account
                  DisplayName: Account
                  Description: Account
                  IsProtected: true
                  IsDeprecated: false
                  IsShared: true
                  IsDataCacheEnabled: true
                  IsTrackingEnabled: true
                  IsAllowOwnerScope: false
                  Category: Common
                  ObjectType: Default
                  IsRecycleBinEnabled: false
                  FieldMetadata:
                  - FieldName: Name
                    DisplayName: Name
                    Description: null
                    DataType: String
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: false
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  - FieldName: Id
                    DisplayName: Id
                    Description: null
                    DataType: Identifier
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: true
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  InternalRuntimeAliasFields: []
                  InternalPrecomputedAliasFields: []
                  PicklistMetadata: []
                  DependentPicklistMetadata: []
                  ComplexFieldMetadata: []
                  AliasFieldMetadata: []
                  IndexMetadata: []
                  TtlFieldMetadata: null
                  CreatedBy:
                    Id: 6739a9f3-fa32-4ee7-bff0-7e92c9dd5ab6
                    Name: System Admin
                  CreatedDate: '2026-08-14T00:04:01.226+00:00'
                  ModifiedBy:
                    Id: f1e469f2-92e5-4d30-95a6-343ca36d9045
                    Name: System Admin
                  ModifiedDate: '2026-08-14T00:04:01.226+00:00'
                  Attributes:
                    PublishDataChangeEvents: true
                    TrackAuditHistory: true
                    IsInternalObject: false
                StatusCode: OK
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiSchemaV1ObjectsByObjectName
      x-operation-id-source: derived
    put:
      tags:
      - Object Definition
      summary: Update a schema definition
      description: Validates and updates an object's schema definition.
      parameters:
      - name: objectName
        in: path
        description: Name of the object
        required: true
        schema:
          type: string
      requestBody:
        description: Details to be updated in the object's schema definition.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ObjectMetadataUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectMetadataAPIResponse'
              example:
                Success: true
                Data:
                  Name: Account
                  DisplayName: Account
                  Description: Account
                  IsProtected: true
                  IsDeprecated: false
                  IsShared: true
                  IsDataCacheEnabled: true
                  IsTrackingEnabled: true
                  IsAllowOwnerScope: false
                  Category: Common
                  ObjectType: Default
                  IsRecycleBinEnabled: false
                  FieldMetadata:
                  - FieldName: Name
                    DisplayName: Name
                    Description: null
                    DataType: String
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: false
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  - FieldName: Id
                    DisplayName: Id
                    Description: null
                    DataType: Identifier
                    DefaultValue: null
                    IsProtected: false
                    IsIndexField: true
                    IsSortable: false
                    IsRequired: true
                    IsUnique: false
                    IsDeprecated: false
                    IsCalculated: false
                    IsInternalField: false
                    IsAliasField: false
                    Length: null
                    LookupObjectName: null
                    LookupFilterCriteria: null
                    DependentPicklistMetadataName: null
                    PicklistName: null
                    ComplexMetadataName: null
                    AutoNumberInitialSeed: 0
                    AutoNumberPrefix: null
                    Precision: 0
                    Scale: 0
                    Expression: null
                    ExpressionDependency: null
                    AliasExpressionDependency: null
                    IsPreComputed: null
                    ReferenceObject: null
                    TargetObject: null
                    TargetField: null
                    RollupFunction: null
                    RollupFilterCriteria: null
                    AliasFieldDefinition: null
                    AliasFieldMetadataName: null
                    IsRichTextField: false
                    IsPropertyLookup: false
                    IdentifierType: null
                  InternalRuntimeAliasFields: []
                  InternalPrecomputedAliasFields: []
                  PicklistMetadata: []
                  DependentPicklistMetadata: []
                  ComplexFieldMetadata: []
                  AliasFieldMetadata: []
                  IndexMetadata: []
                  TtlFieldMetadata: null
                  CreatedBy:
                    Id: 693f0e39-fdc6-42a4-8828-f83ca2554551
                    Name: System Admin
                  CreatedDate: '2026-08-14T00:04:01.223+00:00'
                  ModifiedBy:
                    Id: 06fb2a39-a847-472a-96ea-c739800573b9
                    Name: System Admin
                  ModifiedDate: '2026-08-14T00:04:01.223+00:00'
                  Attributes:
                    PublishDataChangeEvents: true
                    TrackAuditHistory: true
                    IsInternalObject: false
                StatusCode: OK
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: putApiSchemaV1ObjectsByObjectName
      x-operation-id-source: derived
  /api/schema/v1/objects/{objectName}/deprecate:
    patch:
      tags:
      - Object Definition
      summary: Deprecate an object
      description: Deprecates the object in the metadata, accepting the object name as input and setting it to be deprecated.
      parameters:
      - name: objectName
        in: path
        description: Name of the object
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: patchApiSchemaV1ObjectsByObjectNameDeprecate
      x-operation-id-source: derived
  /api/schema/v1/objects/{objectName}/shared/{isShared}:
    put:
      tags:
      - Object Definition
      summary: Set an object's shared status
      description: Sets the IsShared field for the given object to indicate whether the object is shareable.
      parameters:
      - name: objectName
        in: path
        description: Name of the object
        required: true
        schema:
          type: string
      - name: isShared
        in: path
        description: Boolean (True or False)
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      operationId: putApiSchemaV1ObjectsByObjectNameSharedByIsShared
      x-operation-id-source: derived
components:
  schemas:
    ObjectInfo:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
        DisplayName:
          type:
          - string
          - 'null'
        Description:
          type:
          - string
          - 'null'
        Category:
          type:
          - string
          - 'null'
        IsProtected:
          type: boolean
        IsDeprecated:
          type: boolean
        ObjectType:
          $ref: '#/components/schemas/ObjectType'
      additionalProperties: false
    Attributes:
      type: object
      properties:
        PublishDataChangeEvents:
          type: boolean
        TrackAuditHistory:
          type: boolean
        IsInternalObject:
          type: boolean
      additionalProperties: false
    StringStringDictionaryAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    PicklistEntryCreateRequest:
      type: object
      properties:
        Value:
          type:
          - string
          - 'null'
          description: Value of the picklist entry
        DisplayText:
          type:
          - string
          - 'null'
          description: Display text of the picklist entry
        Sequence:
          type: integer
          description: Sequence of the picklist entry
          format: int32
      additionalProperties: false
    DependentPicklistMetadataRequest:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: Name of the dependent picklist
        DependentFieldName:
          type:
          - string
          - 'null'
          description: Dependent field name of the picklist
        ControllingFieldName:
          type:
          - string
          - 'null'
          description: Controlling field name of the picklist
        ControllingAndDependentPicklistEntries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ControllingDependentPicklistEntryCreateRequest'
          description: Collection of the controlling and dependent picklist
      additionalProperties: false
    ObjectMetadataAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          $ref: '#/components/schemas/ObjectMetadata'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    ErrorDetail:
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
      additionalProperties: false
    AliasFieldMetadata:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
        AliasFieldDefinitionDetail:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AliasFieldDefinitionDetail'
      additionalProperties: false
    FieldMetadataCreateRequest:
      type: object
      properties:
        FieldName:
          type:
          - string
          - 'null'
          description: Name of the field. You can enter up to 58 characters.
        DisplayName:
          type:
          - string
          - 'null'
          description: Display name of the field
        Description:
          type:
          - string
          - 'null'
          description: Description of the field
        DataType:
          $ref: '#/components/schemas/DataType'
        DefaultValue:
          type:
          - string
          - 'null'
          description: Default value of the field
        IsRequired:
          type: boolean
          description: Indicates if the field is required.
        IsSortable:
          type: boolean
          description: Indicates if the field is sortable.
        IsUnique:
          type: boolean
          description: Indicates if the field is unique.
        IsIndexField:
          type: boolean
          description: Indicates if the field is indexed.
        LookupObjectName:
          type:
          - string
          - 'null'
          description: Lookup object name of the field
        LookupFilterCriteria:
          type:
          - string
          - 'null'
          description: Lookup filter criteria for UI
        PicklistName:
          type:
          - string
          - 'null'
          description: Picklist name of the field
        DependentPicklistMetadataName:
          type:
          - string
          - 'null'
          description: Dependent picklist metadata name of the field
        ComplexMetadataName:
          type:
          - string
          - 'null'
          description: Complex metadata name of the field
        AutoNumberInitialSeed:
          type: integer
          description: AutoNumber initial seed value of the field
          format: int32
        AutoNumberPrefix:
          type:
          - string
          - 'null'
          description: AutoNumber initial seed prefix of the field
        Precision:
          type: integer
          description: Precision of the field when the data type is Currency, Decimal, or Double.
          format: int32
        Scale:
          type: integer
          description: Scale of the field when the data type is Currency, Decimal, or Double.
          format: int32
        IsCalculated:
          type: boolean
          description: Indicates if the field is calculated.
        Expression:
          type:
          - string
          - 'null'
          description: Describes the expression of the formula field
        IsPreComputed:
          type:
          - boolean
          - 'null'
          description: Indicates if Formula expression is pre-computed or not
        Length:
          type:
          - integer
          - 'null'
          description: Length of the field when the data type is String or LongString.
          format: int32
        ReferenceObject:
          type:
          - string
          - 'null'
          description: Reference object of the field
        TargetObject:
          type:
          - string
          - 'null'
          description: Target object of the field
        TargetField:
          type:
          - string
          - 'null'
          description: Target field of the field
        RollupFunction:
          type:
          - string
          - 'null'
          description: Rollup function of the field
        RollupFilterCriteria:
          type:
          - string
          - 'null'
          description: Rollup filter criteria of the field
        IsRichTextField:
          type: boolean
          description: Indicates if the field is RichText.
        IdentifierType:
          $ref: '#/components/schemas/IdentifierType'
        AliasFieldDefinition:
          type:
          - strin

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-object-definition-api-openapi.yml