> ## Documentation Index > Fetch the complete documentation index at: https://docs.claap.io/llms.txt > Use this file to discover all available pages before exploring further. # Get admin automation > Retrieve a single admin automation. Retrieves a single admin automation. ## OpenAPI ````yaml GET /v1/admin-automations/{adminAutomationId} openapi: 3.1.0 info: title: Claap API description: Development documentation version: 0.0.0 servers: - url: https://api.claap.io/ security: - ApiKey: [] paths: /v1/admin-automations/{adminAutomationId}: get: description: Retrieve a single admin automation. operationId: getV1AdminAutomationsByAdminAutomationId parameters: - in: path name: adminAutomationId schema: type: string description: Admin automation identifier required: true responses: '200': description: Admin automation was successfully retrieved content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/AdminAutomation' required: - result '404': description: >- Admin automation was not found. Note that automations that define no action at all cannot be accessed through the API and are reported as not found. components: schemas: AdminAutomation: type: object properties: adminAutomationId: type: string description: The admin automation identifier. name: type: string description: The admin automation name. color: type: string enum: - blue - green - yellow - purple - red - bordeaux - turquoise description: The color used to display the automation in Claap. disallowUserOverride: type: boolean description: >- Whether the automation is enforced, preventing members from overriding it with their personal preferences. filters: type: array items: $ref: '#/components/schemas/AdminAutomationFilter' description: >- The filters selecting which meetings the automation applies to. An automation without filters applies to all meetings. actions: $ref: '#/components/schemas/AdminAutomationActions' description: The actions applied to matching meetings. required: - adminAutomationId - name - color - disallowUserOverride - filters - actions description: >- An admin automation (recording automation configured by workspace admins). AdminAutomationFilter: oneOf: - $ref: '#/components/schemas/AdminAutomationMeetingTypeFilter' - $ref: '#/components/schemas/AdminAutomationOrganizerIsFilter' - $ref: '#/components/schemas/AdminAutomationParticipantsContainsFilter' - $ref: '#/components/schemas/AdminAutomationRecorderUserGroupIsFilter' - $ref: '#/components/schemas/AdminAutomationTextContainsFilter' - $ref: '#/components/schemas/AdminAutomationTextExistsFilter' - $ref: '#/components/schemas/AdminAutomationTextIsFilter' - $ref: '#/components/schemas/AdminAutomationMeetingSourceIsFilter' - $ref: '#/components/schemas/AdminAutomationFolderIsFilter' - $ref: '#/components/schemas/AdminAutomationGroupFilter' description: A filter selecting which meetings an admin automation applies to. AdminAutomationActions: type: object properties: autoRecord: type: object properties: onlyHosted: type: boolean default: false description: Only record the meeting when a workspace member is the host. toBeRecorded: type: boolean default: true description: >- Whether matching meetings are recorded. Set to false to prevent recording instead. description: >- Automatically record (or prevent recording of) matching meetings. Cannot be combined with a `FolderIs` filter. autoShare: type: object properties: autoShare: type: string enum: - AllParticipants - InternalOnly - AuthorOnly - None default: AllParticipants description: >- Who the recording is shared with: all meeting participants, internal participants only, the author only, or nobody. publicLayout: type: string enum: - None - AiNotes - All description: >- Which parts of the recording are visible through the public link. publicLinkEnabled: type: boolean default: false description: Whether a public link is enabled for the recording. publish: type: string enum: - InviteOnly - AnyoneWithLink - Everyone default: InviteOnly description: >- How the recording is published in the workspace: `InviteOnly` (only people it is shared with), `AnyoneWithLink` (any workspace member with the link) or `Everyone` (visible to the whole workspace). description: Automatically control how matching recordings are shared. moveToFolder: type: object properties: folderId: type: string description: >- Identifier of the destination folder (aka channel). May be missing on automations that were created in Claap without a destination folder. description: Automatically add matching recordings to a folder (aka channel). updateOverview: type: object properties: sectionIds: type: array items: type: string description: >- Identifiers of the summary sections used to personalize the AI notes. description: >- Automatically personalize the AI notes of matching recordings with the given summary sections. anyOf: - required: - autoRecord - required: - autoShare - required: - moveToFolder - required: - updateOverview description: >- The actions applied to matching meetings. At least one action is always defined. AdminAutomationMeetingTypeFilter: title: MeetingType filter type: object properties: type: type: string enum: - MeetingType description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. meetingType: type: string enum: - Internal - External description: >- Match `Internal` meetings (every participant belongs to the organization) or `External` meetings (at least one outside participant). required: - type - meetingType description: Match meetings by type, internal or external. AdminAutomationOrganizerIsFilter: title: OrganizerIs filter type: object properties: type: type: string enum: - OrganizerIs description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. name: type: string description: The name of the meeting organizer (host) to match. userId: type: string description: >- Optional workspace member identifier of the organizer. When provided, it must identify an active workspace member. required: - type - name description: Match meetings organized (hosted) by a given person. AdminAutomationParticipantsContainsFilter: title: ParticipantsContains filter type: object properties: type: type: string enum: - ParticipantsContains description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. participants: type: array items: type: object properties: name: type: string description: The name of the participant to match. userId: type: string description: >- Optional workspace member identifier of the participant. When provided, it must identify an active workspace member. required: - name description: The people to look for among the meeting participants. required: - type - participants description: Match meetings whose participants include the given people. AdminAutomationRecorderUserGroupIsFilter: title: RecorderUserGroupIs filter type: object properties: type: type: string enum: - RecorderUserGroupIs description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. userGroupId: type: string description: >- Identifier of the workspace team (user group). It must identify an existing team of the workspace. required: - type - userGroupId description: Match meetings recorded by a member of a given team. AdminAutomationTextContainsFilter: title: TextContains filter type: object properties: type: type: string enum: - TextContains description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. text: type: string description: The text to look for. textField: type: string enum: - Title default: Title description: >- The text field the filter applies to. Only `Title` (the meeting title) is supported. required: - type - text description: Match meetings whose title contains the given text. AdminAutomationTextExistsFilter: title: TextExists filter type: object properties: type: type: string enum: - TextExists description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. textField: type: string enum: - Title default: Title description: >- The text field the filter applies to. Only `Title` (the meeting title) is supported. required: - type description: Match meetings where the text field is set. AdminAutomationTextIsFilter: title: TextIs filter type: object properties: type: type: string enum: - TextIs description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. text: type: string description: The exact text to match. textField: type: string enum: - Title default: Title description: >- The text field the filter applies to. Only `Title` (the meeting title) is supported. required: - type - text description: Match meetings whose title is exactly the given text. AdminAutomationMeetingSourceIsFilter: title: MeetingSourceIs filter type: object properties: type: type: string enum: - MeetingSourceIs description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. source: type: string enum: - Aircall - Allo - Api - Call - GoogleMeet - LemlistVoip - Loom - MobileApp - MsTeams - Ringover - Uploaded - Zoom description: The recording source to match. required: - type - source description: Match recordings coming from a given source. AdminAutomationFolderIsFilter: title: FolderIs filter type: object properties: type: type: string enum: - FolderIs description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. folderId: type: string description: >- Identifier of the folder (aka channel) to match. It must identify a folder of the workspace that is accessible to workspace members. required: - type - folderId description: >- Match recordings added to a given folder (aka channel). This filter cannot be combined with the `autoRecord` action. AdminAutomationGroupFilter: title: Group filter type: object properties: type: type: string enum: - Group description: The filter type. combineWith: type: string enum: - And - Or description: >- How this filter combines with the other filters of the automation. When omitted, the top-level `combineWith` value of the request is used. not: type: boolean default: false description: Set to true to negate the filter and match the opposite condition. filters: type: array items: oneOf: - $ref: '#/components/schemas/AdminAutomationMeetingTypeFilter' - $ref: '#/components/schemas/AdminAutomationOrganizerIsFilter' - $ref: '#/components/schemas/AdminAutomationParticipantsContainsFilter' - $ref: '#/components/schemas/AdminAutomationRecorderUserGroupIsFilter' - $ref: '#/components/schemas/AdminAutomationTextContainsFilter' - $ref: '#/components/schemas/AdminAutomationTextExistsFilter' - $ref: '#/components/schemas/AdminAutomationTextIsFilter' - $ref: '#/components/schemas/AdminAutomationMeetingSourceIsFilter' - $ref: '#/components/schemas/AdminAutomationFolderIsFilter' description: The filters of the group. Groups cannot contain other groups. required: - type - filters description: Combine several filters into a group, evaluated as a single filter. securitySchemes: ApiKey: type: apiKey in: header name: X-Claap-Key ````