Conga

Conga Record Type Permission API

The Record Type Permission API from Conga — 5 operation(s) for record type permission.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/user-management/v1/recordtype-permissions Grant a record type permission · Set a record type's permission #
Ask an LLM
“How do I give a permission group access to specific record types on an object?”
“What ID do I get back after setting a new record type permission?”
Tell an agent
Grant permission group {PermissionGroupName} record type access {RecordTypeAccess} on {ObjectName}.
Set a new record type permission for object {ObjectName} and group {PermissionGroupName}.
PUT /api/user-management/v1/recordtype-permissions Update record type access by group and object · Update a record type's permission for a given permission group and object #
Ask an LLM
“How do I change which record types a permission group can use on an object, without knowing the permission ID?”
“Can I update record type access by naming the permission group and object?”
Tell an agent
Update record type access on {ObjectName} for permission group {PermissionGroupName} to {RecordTypeAccess}.
Change permission group {PermissionGroupName}'s record type permission on object {ObjectName}.
POST /api/user-management/v1/recordtype-permissions/bulk Grant many record type permissions at once · Set multiple record type permissions #
Ask an LLM
“Can I set record type permissions for several groups and objects in one request?”
“Is there a bulk way to load record type permissions?”
Tell an agent
Bulk-set these record type permissions.
Create several record type permissions in one batch.
DELETE /api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName} Revoke record type access by group and object · Delete a record type's permission by permission group and object #
Ask an LLM
“How do I remove a permission group's record type access on an object?”
“Can I revoke a record type permission using the group name and object?”
Tell an agent destructive · confirm first
Revoke record type access of group {permissionGroupName} on {objectName}.
Delete permission group {permissionGroupName}'s record type permission for object {objectName}.
GET /api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName} Get record type access by group and object · Get the record type permission details by object and permission group name #
Ask an LLM
“Which record types can a given permission group access on an object?”
“Can I look up a record type permission by group name and object instead of ID?”
Tell an agent
Show record type access for permission group {permissionGroupName} on {objectName}.
Get the record type permission of group {permissionGroupName} for object {objectName}.
DELETE /api/user-management/v1/recordtype-permissions/{recordTypePermissionId} Delete a record type permission by ID · Delete a record type's permission by ID #
Ask an LLM
“How do I delete a record type permission when I have its ID?”
“What's the way to remove one record type permission record by its identifier?”
Tell an agent destructive · confirm first
Delete record type permission {recordTypePermissionId}.
Remove the record type permission with ID {recordTypePermissionId}.
GET /api/user-management/v1/recordtype-permissions/{recordtypePermissionId} Get a record type permission by ID · Get the record type permission details by ID #
Ask an LLM
“How do I fetch a record type permission's details from its ID?”
“What does a specific record type permission record contain?”
Tell an agent
Get record type permission {recordtypePermissionId}.
Show details of the record type permission with ID {recordtypePermissionId}.
PUT /api/user-management/v1/recordtype-permissions/{recordtypePermissionId} Update a record type permission by ID · Update a record type's permission #
Ask an LLM
“Can I edit a record type permission using its permission ID?”
“Which fields can I change on an existing record type permission by ID?”
Tell an agent
Update record type permission {recordtypePermissionId} to access {RecordTypeAccess}.
Edit record type permission ID {recordtypePermissionId}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-record-type-permission-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-record-type-permission-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-record-type-permission-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: User Management Record Type Permission API
  version: v1
servers:
- url: https://rls.congacloud.com
security:
- Bearer: []
tags:
- name: Record Type Permission
paths:
  /api/user-management/v1/recordtype-permissions:
    post:
      tags:
      - Record Type Permission
      summary: Set a record type's permission
      description: Sets a record type's permission and returns its unique identifier (ID).
      requestBody:
        description: Record type permission model data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: 558adfb2-64f4-410a-9b12-d2bebe3b8134
                StatusCode: Created
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: postApiUserManagementV1RecordtypePermissions
      x-operation-id-source: derived
    put:
      tags:
      - Record Type Permission
      summary: Update a record type's permission for a given permission group and object
      description: Updates a record type's permission for a given permission group and object, and returns the updated record type permission details.
      requestBody:
        description: Updated model data for the record type permission
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordTypePermissionAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObjectName
                  PermissionGroupName: SamplePermissionGroupName
                  RecordTypeAccess: '{"NDA":{"Enabled":true},"MSA":{"Enabled":false}}'
                  Id: 235c8e3a-ee50-4399-aa58-c2be867b051c
                  Name: SampleObjectName.SamplePermissionGroupName
                  CreatedBy:
                    Id: fea189b1-59c1-4ff4-afb2-61a6a924895a
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:36.2115738+00:00'
                  ModifiedBy:
                    Id: 98bb8dbb-39e1-461b-839c-3c36e631dd22
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:36.2115828+00:00'
                  ExternalId: c8021920-5ea2-44fe-88b5-283432007412
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: putApiUserManagementV1RecordtypePermissions
      x-operation-id-source: derived
  /api/user-management/v1/recordtype-permissions/bulk:
    post:
      tags:
      - Record Type Permission
      summary: Set multiple record type permissions
      description: Sets multiple record type permissions and returns their unique identifiers (ID).
      requestBody:
        description: Record type permission model data
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RecordTypePermissionCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListAPIResponse'
              example:
                Success: true
                Data:
                - ddd532da-dd12-414b-bb01-14793a0ff7e0
                - 45f6a55d-4041-4790-9e00-72ed9358c015
                StatusCode: Created
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: postApiUserManagementV1RecordtypePermissionsBulk
      x-operation-id-source: derived
  /api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName}:
    delete:
      tags:
      - Record Type Permission
      summary: Delete a record type's permission by permission group and object
      description: Removes a record type's permission from the given permission group and object.
      parameters:
      - name: objectName
        in: path
        description: Object name
        required: true
        schema:
          type: string
      - name: permissionGroupName
        in: path
        description: Permission group name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: 5599fcaa-ead7-48d3-af95-3cfc22663cb1 deleted successfully.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: deleteApiUserManagementV1RecordtypePermissionsByPermissionGroupNameByObjectName
      x-operation-id-source: derived
    get:
      tags:
      - Record Type Permission
      summary: Get the record type permission details by object and permission group name
      description: Fetches the record type permission details based on the object and permission group name.
      parameters:
      - name: objectName
        in: path
        description: Object name
        required: true
        schema:
          type: string
      - name: permissionGroupName
        in: path
        description: Permission group name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringObjectDictionaryAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObject
                  PermissionGroupName: ViewAllPermissionGroup
                  Id: 9e2b0ed6-ae9e-4aee-a76e-de3ddc30b29b
                  RecordTypeAccess:
                    NDA:
                      Enabled: true
                    MSA:
                      Enabled: false
                    Master:
                      Enabled: true
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiUserManagementV1RecordtypePermissionsByPermissionGroupNameByObjectName
      x-operation-id-source: derived
  /api/user-management/v1/recordtype-permissions/{recordTypePermissionId}:
    delete:
      tags:
      - Record Type Permission
      summary: Delete a record type's permission by ID
      description: Removes a record type's permission for the given record type permission ID.
      parameters:
      - name: recordTypePermissionId
        in: path
        description: Record type permission ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: 143dc26f-06b4-49a6-9479-158793070dea deleted successfully.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: deleteApiUserManagementV1RecordtypePermissionsByRecordTypePermissionId
      x-operation-id-source: derived
  /api/user-management/v1/recordtype-permissions/{recordtypePermissionId}:
    get:
      tags:
      - Record Type Permission
      summary: Get the record type permission details by ID
      description: Fetches the record type permission details based on the record type permission ID.
      parameters:
      - name: recordtypePermissionId
        in: path
        description: Record type permission ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordTypePermissionAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObjectName
                  PermissionGroupName: SamplePermissionGroupName
                  RecordTypeAccess: '{"NDA":{"Enabled":false},"MSA":{"Enabled":false}}'
                  Id: 22afaccf-dcf6-44df-a2a8-74bfa7f9d580
                  Name: SampleObjectName.SamplePermissionGroupName
                  CreatedBy:
                    Id: 082b4fc9-18a4-42fd-a0ae-f7dc20039538
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:36.2302891+00:00'
                  ModifiedBy:
                    Id: 37450513-a59a-4b82-b6dd-bbb66262ae9f
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:36.2302977+00:00'
                  ExternalId: 964cf095-8c11-464f-9b4f-fe675325a047
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiUserManagementV1RecordtypePermissionsByRecordtypePermissionId
      x-operation-id-source: derived
    put:
      tags:
      - Record Type Permission
      summary: Update a record type's permission
      description: Updates a record type's permission and returns the updated record type permission details.
      parameters:
      - name: recordtypePermissionId
        in: path
        description: Record type permission ID
        required: true
        schema:
          type: string
      requestBody:
        description: Updated model data for the record type permission
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RecordTypePermissionUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordTypePermissionAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObjectName
                  PermissionGroupName: SamplePermissionGroupName
                  RecordTypeAccess: '{"NDA":{"Enabled":true},"MSA":{"Enabled":false}}'
                  Id: 69a83b0d-4117-4bff-b5c2-14b6c7a4e011
                  Name: SampleObjectName.SamplePermissionGroupName
                  CreatedBy:
                    Id: c751c386-bd3d-467e-9c7f-369fc002e2b9
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:36.2356202+00:00'
                  ModifiedBy:
                    Id: 2c13db53-e384-4294-8b78-4164f283a5cc
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:36.235628+00:00'
                  ExternalId: 51eef340-c05e-4d37-a567-fcd0532c0f17
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: putApiUserManagementV1RecordtypePermissionsByRecordtypePermissionId
      x-operation-id-source: derived
components:
  schemas:
    RecordTypeAccessConfig:
      type: object
      properties:
        RecordTypeName:
          type:
          - string
          - 'null'
          description: Record type name
        Enabled:
          type: boolean
      additionalProperties: false
    HttpStatusCode:
      enum:
      - Continue
      - SwitchingProtocols
      - Processing
      - EarlyHints
      - OK
      - Created
      - Accepted
      - NonAuthoritativeInformation
      - NoContent
      - ResetContent
      - PartialContent
      - MultiStatus
      - AlreadyReported
      - IMUsed
      - MultipleChoices
      - MovedPermanently
      - Found
      - SeeOther
      - NotModified
      - UseProxy
      - Unused
      - TemporaryRedirect
      - PermanentRedirect
      - BadRequest
      - Unauthorized
      - PaymentRequired
      - Forbidden
      - NotFound
      - MethodNotAllowed
      - NotAcceptable
      - ProxyAuthenticationRequired
      - RequestTimeout
      - Conflict
      - Gone
      - LengthRequired
      - PreconditionFailed
      - RequestEntityTooLarge
      - RequestUriTooLong
      - UnsupportedMediaType
      - RequestedRangeNotSatisfiable
      - ExpectationFailed
      - MisdirectedRequest
      - UnprocessableEntity
      - Locked
      - FailedDependency
      - UpgradeRequired
      - PreconditionRequired
      - TooManyRequests
      - RequestHeaderFieldsTooLarge
      - UnavailableForLegalReasons
      - InternalServerError
      - NotImplemented
      - BadGateway
      - ServiceUnavailable
      - GatewayTimeout
      - HttpVersionNotSupported
      - VariantAlsoNegotiates
      - InsufficientStorage
      - LoopDetected
      - NotExtended
      - NetworkAuthenticationRequired
      type: string
    StringObjectDictionaryAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - object
          - 'null'
          additionalProperties: {}
        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
    StringListAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - array
          - 'null'
          items:
            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
    RecordTypePermission:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        ObjectName:
          type:
          - string
          - 'null'
        PermissionGroupName:
          type:
          - string
          - 'null'
        RecordTypeAccess: {}
      additionalProperties: {}
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    RecordTypePermissionCreateRequest:
      type: object
      properties:
        ObjectName:
          type:
          - string
          - 'null'
          description: Object for which record type permission is to be created.
        PermissionGroupName:
          type:
          - string
          - 'null'
          description: Permission group name for which record type permission is to be created.
        RecordTypeAccess:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecordTypeAccessConfig'
          description: Collection of record type access
      additionalProperties: false
    RecordTypePermissionUpdateRequest:
      type: object
      properties:
        ObjectName:
          type:
          - string
          - 'null'
          description: Object name for which record type permission is to be updated.
        PermissionGroupName:
          type:
          - string
          - 'null'
          description: Permission group name for which record type permission is to be updated.
        RecordTypeAccess:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecordTypeAccessConfig'
          description: Collection of record type access
      additionalProperties: false
    StringAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - string
          - 'null'
        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
    RecordTypePermissionAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          $ref: '#/components/schemas/RecordTypePermission'
        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
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header