### GraphQL Input Object: FeatureInstallRequest Definition

Source: https://docs.carerix.io/graphql/welcome/types/FeatureInstallRequest

Defines the structure for the FeatureInstallRequest input object, used to create or install new features within the system. It specifies the required manifest and optional settings for feature installation.

```APIDOC
FeatureInstallRequest Input Object:
  Description: A command to create/install new feature
  Fields:
    _kind: ID! (Non-null)
    manifest: ReferenceRequest! (Non-null)
      Description: Feature's manifest to install
    settings: [FeatureSettingsInput]
      Description: Setting to init feature
  Usages:
    Argument 'request' of field 'featureInstall' from type 'Mutation'
```

--------------------------------

### GraphQL aiPrompt Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/aiPrompt

Details the `aiPrompt` GraphQL query, including its arguments, return type, and associated directives.

```APIDOC
aiPrompt Query:
  Description: Read AI Prompt by identifier
  Arguments:
    _id:
      Type: ID!
      Description: Non-null
  Response:
    Returns: AiPrompt
  Directives:
    @cost:
      Value: 1
```

--------------------------------

### PRBitVector Scalar API Definition and Usage

Source: https://docs.carerix.io/graphql/welcome/types/PRBitVector

Defines the PRBitVector scalar type, its string representation format, and provides an example. It also lists the API fields where this scalar is referenced.

```APIDOC
PRBitVector Scalar
  Description: BitVector class cluster represented as String.
  Format: [%length{-|+}:%{set-bits}]
    %length: The length (in bits) of the vector
    {-|+}: Indicates the unset-bit (unset-bit or set-bit indicator)
    %{set-bits}: A list of indexes of set (non-zero) bits
  Example: [8-:1-3]

Usages/References:
  - Field checklistBits from CREmployee
  - Field documentBits from CREmployee
```

--------------------------------

### GraphQL piDashboard Query API Reference

Source: https://docs.carerix.io/graphql/welcome/queries/piDashboard

Detailed API documentation for the `piDashboard` GraphQL query, including its arguments and expected response type.

```APIDOC
piDashboard Query:
  Description: Fetch single of Dashboard
  Arguments:
    _id:
      Type: ID!
      Description: Non-null
  Response: PIDashboard
```

--------------------------------

### GraphQL Feature Object Definition

Source: https://docs.carerix.io/graphql/welcome/types/Feature

Defines the structure and properties of the Feature object in the GraphQL API, including its fields, interfaces, and where it is referenced. This object describes the installation of a Manifest for a tenant.

```APIDOC
Feature Object:
  Description: Feature describes installation of a Manifest for a tenant.
  Directives: @anyScope, @anyScope(names: ["urn:cx/features:data/features:read:all", "urn:cx/features:data/features:update:all"])
  Fields:
    _createdBy: Auditor
    _createdDateTime: Instant
    _id: ID! (Non-null, Unique identifier of a record.)
    _kind: ID! (Non-null, Record type.)
    _updatedBy: Auditor
    _updatedDateTime: Instant
    manifest: Manifest! (Non-null, Feature's manifest)
    manifestVersion: String! (Non-null, Version of manifest used by current installation)
    settings: [[FeatureSettings]] (Feature's configuration per service, Available settings are defined by feature's manifest)
    status: FeatureStatus (Feature's status)
  Interfaces:
    - APIResource
  Usages (References):
    - Field featureActivate from Mutation
    - Field featureDeactivate from Mutation
    - Field featureInstall from Mutation
```

--------------------------------

### GraphQL lead Query API Reference

Source: https://docs.carerix.io/graphql/welcome/queries/lead

Detailed API documentation for the 'lead' GraphQL query, including its required arguments and the structure of its response.

```APIDOC
lead Query:
  Description: Read lead by id
  Arguments:
    _id:
      Type: ID!
      Description: Non-null
  Response:
    Type: Lead
```

--------------------------------

### GraphQL officeEmployeeCreate Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/officeEmployeeCreate

Details the `officeEmployeeCreate` GraphQL mutation, including its arguments and return type.

```APIDOC
officeEmployeeCreate Mutation:
  Description: Create office employee with credentials
  Arguments:
    request:
      Type: OfficeEmployeeCreateRequest!
      Description: Non-null
  Response:
    Type: OfficeEmployee
```

--------------------------------

### GraphQL ID Scalar Type Definition and Usage

Source: https://docs.carerix.io/graphql/welcome/types/ID

Defines the GraphQL `ID` scalar type, its characteristics, and lists examples of fields that utilize this type across various GraphQL objects.

```APIDOC
GraphQL ID Scalar Type:
  Description: The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
  Usages:
    References:
      - Field _id from AiPrompt
      - Field _kind from AiPrompt
      - Field _id from Candidate
      - And 919 more references.
```

--------------------------------

### GraphQL featureInstall Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/featureInstall

Details the arguments required for the featureInstall mutation and the structure of its response. This mutation is used to install a new or previously uninstalled Feature, setting its status to `deactivated` upon successful completion.

```APIDOC
featureInstall Mutation:
  Description: Install a new or previously uninstalled Feature. If installation succeeds, a Feature will move to `deactivated` status.
  Arguments:
    request:
      Type: FeatureInstallRequest!
      Description: Feature's configuration
      Nullable: No
  Response:
    Returns: Feature
```

--------------------------------

### crEmployeeApply Mutation API Reference

Source: https://docs.carerix.io/graphql/welcome/mutations/crEmployeeApply

Detailed API documentation for the crEmployeeApply GraphQL mutation, including all available arguments with their types and descriptions, and the expected response type.

```APIDOC
crEmployeeApply Mutation

Arguments:
  confirmMail: String
    Description: Code of the template for the confirmation e-mail. Defaults to 'web-confirm'
  dedupe: Boolean
    Description: Enables employee de-duplication. When false, deduplication is disabled. Defaults to true.
  dupmatchMail: String
    Description: Code of the template for email, to inform that apply resulted in duplicate match creation
  language: Language
  nomatch: Boolean
    Description: Prevent the creation of a match with the publication's vacancy when set to true. Defaults to false.
  orgpub: ID
    Description: Primary key of CRPublication on the affiliate website through which the applicant browsed to the web portal website
  prod: ID
    Description: Business line (CRDataNode ID) for an open application.
  pub: ID
    Description: Primary key of CRPublication (published vacancy).
  request: CREmployeeRequest ! (Non-null)
  webConfirmDeclineEmail: Boolean
    Description: If true - confirmation email would not be sent.
  webDupmatchDeclineEmail: Boolean
    Description: If true - email-warning about duplicate match would not be sent.
  webDupwarnDeclineEmail: Boolean
    Description: If true - email-warning about possible duplicates would not be sent.
  webNotifyDeclineEmail: Boolean
    Description: If true - notification email would not be sent.

Response:
  Returns CREmployee.
```

--------------------------------

### GraphQL DateTime Object Definition

Source: https://docs.carerix.io/graphql/welcome/types/DateTime

Defines the structure of the DateTime object, listing its fields and their respective types. It also indicates where this object is referenced within the API, specifically by the 'Event' type's 'end' and 'start' fields.

```APIDOC
DateTime Object:
  Fields:
    date: String
    time: String
    timezone: String
  Usages:
    References:
      - Field end from Event
      - Field start from Event
```

--------------------------------

### FieldBusinessRule Object API Definition

Source: https://docs.carerix.io/graphql/welcome/types/FieldBusinessRule

Defines the structure and fields of the FieldBusinessRule object, used for validation rule definitions within the GraphQL API. It includes details on its properties, their types, nullability, and descriptions, along with an example for the 'condition' field.

```APIDOC
FieldBusinessRule Object:
  Description: Validation rule definition
  Fields:
    _kind:
      Type: ID!
      Description: Non-null
    code:
      Type: String!
      Description: Non-null
    condition:
      Type: String!
      Description: Non-null. Predicate for possible value. Example: `length(value) eq 5 or length(value) eq $abc`
    variables:
      Type: [FieldBusinessRuleVariable]
      Description: Variables used in Rule's condition
  Usages:
    References:
      - Field 'rules' from ManifestSetting
```

--------------------------------

### GraphQL FrontendSetting Object Definition

Source: https://docs.carerix.io/graphql/welcome/types/FrontendSetting

Detailed API documentation for the FrontendSetting object, including its fields, their types, descriptions, and its interfaces and references within the GraphQL schema.

```APIDOC
FrontendSetting Object:
  Description: Setting representation
  Directives:
    - @anyScope
    - @anyScope(names: ["urn:cx/seamless:data:manage"])
  Fields:
    _id:
      Type: ID!
      Description: Non-null, Setting id
    _kind:
      Type: ID!
      Description: Non-null, Kind of API resource being updated, must always be 'FrontendSetting'
    config:
      Type: Properties
      Description: Additional setting configuration
    defaultValue:
      Type: Value
      Description: Setting default value. Value must match setting type
    name:
      Type: String!
      Description: Non-null, Setting name
    namespace:
      Type: String!
      Description: Non-null, Setting namespace
    type:
      Type: SettingType
      Description: Setting type: number, boolean, string, text, date, time, datetime
    value:
      Type: Value
      Description: Current setting value
  Interfaces:
    - APIResource
  Usages (References):
    - Field 'items' from FrontendSettingPage
    - Field 'frontendSettingReset' from Mutation
    - Field 'frontendSettingUpdate' from Mutation
```

--------------------------------

### GraphQL Schema Field and Directive Documentation

Source: https://docs.carerix.io/graphql/welcome/types/CRInvoiceLine

Provides detailed documentation for a set of GraphQL fields, including their types (Float, NSDictionary, String) and their roles in the schema, such as being part of specific unions or being a field from another type. Also includes an example of the `@anyScope` directive.

```APIDOC
GraphQL Directive:
  @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])

GraphQL Type Fields:
  total: Float
  transientInfo: NSDictionary
  tueNumber: Float
  unit: String
  wedNumber: Float
  weekTotalNumber: Float

Usages:
  References:
    - Part of union: CRAttachmentObject
    - Part of union: CRAttributeChangeObject
    - Field toCreditInvoiceLine from: CRInvoiceLine
```

--------------------------------

### GraphQL userCreate Mutation API Reference

Source: https://docs.carerix.io/graphql/welcome/mutations/userCreate

Detailed API documentation for the `userCreate` GraphQL mutation, specifying its input arguments and the structure of its response.

```APIDOC
userCreate Mutation:
  Description: Create a new user.
  Arguments:
    request: UserCreateRequest! (Non-null)
  Returns: User
```

--------------------------------

### GraphQL SimplePageable Input Object Definition and Usage

Source: https://docs.carerix.io/graphql/welcome/types/SimplePageable

Defines the structure of the SimplePageable input object used for pagination in GraphQL queries. It specifies the 'page' and 'size' fields, both of type Int, and lists examples of fields where this input object is utilized as a 'pageable' argument.

```GraphQL
SimplePageable Input Object:
  Fields:
    page: Int
    size: Int
  Usages:
    - Argument 'pageable' of field 'allAttachments' from type CRAgency
    - Argument 'pageable' of field 'attachments' from type CRAgency
    - Argument 'pageable' of field 'children' from type CRAgency
    - (and 297 more references)
```

--------------------------------

### GraphQL oAuth2Client Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/oAuth2Client

Detailed API documentation for the oAuth2Client GraphQL query, including its required arguments and the structure of the returned OAuth2Client object.

```APIDOC
Query: oAuth2Client
Description: Retrieve an OAuth2 client by any of its unique identifiers: technical _id, human-readable code or OAuth2 client ID from credentials.clientId.

Arguments:
  _id:
    Type: ID! (Non-null)
    Description: An identifier of a client. Values from _id, code or credentials.clientId may be used here.

Response:
  Type: OAuth2Client
```

--------------------------------

### GraphQL Type Arguments and References

Source: https://docs.carerix.io/graphql/welcome/types/CRLead

This snippet details the arguments associated with a GraphQL type and its various references within the schema, including its role in unions and as fields in other types. It also shows an example of the @anyScope directive usage with specific permission URNs.

```GraphQL
GraphQL Type Details:

Directive Example:
  @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/crvacancy:read", "urn:cx/cx5Wrapper:data/crvacancy:manage"])

Arguments:
  workCity: String
  workLocation: String
  workPostalCode: String

References:
  Part of union: CRAttachmentObject
  Field toLead from: CRLeadAttachment
  Field toLead from: CRLeadGroup
```

--------------------------------

### GraphQL vacancy Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/vacancy

Documents the 'vacancy' GraphQL query, including its arguments, return type, and associated directives for cost analysis.

```APIDOC
Query: vacancy
  Description: Read vacancy by id
  Arguments:
    _id:
      Type: ID!
      Description: Non-null unique identifier for the vacancy.
  Response:
    Returns: Vacancy
  Directives:
    @cost:
      Description: Directive to specify query cost.
      Example: @cost(value: 1)
```

--------------------------------

### NSCalendarDate GraphQL Scalar Definition and Usages

Source: https://docs.carerix.io/graphql/welcome/types/NSCalendarDate

This API documentation defines the NSCalendarDate scalar type, outlining its expected string format and timezone. It also lists examples of fields within the GraphQL schema where this scalar is used, such as creationDate and modificationDate in CRAgency and CRArticle types, indicating a broader usage across the API.

```APIDOC
NSCalendarDate Scalar:
  Description: Date-Time as String. Format: 'yyyy-MM-dd HH:mm:ss' at Amsterdam timezone.
  Usages:
    - Field creationDate from CRAgency
    - Field modificationDate from CRAgency
    - Field creationDate from CRArticle
    - ... (272 more usages)
```

--------------------------------

### GraphQL crLeadStageCreate Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crLeadStageCreate

Documents the `crLeadStageCreate` GraphQL mutation, detailing its input arguments and the structure of the returned `CRLeadStage` object.

```APIDOC
crLeadStageCreate Mutation
  Description: Create CRLeadStage
  Arguments:
    language: Language
    request: CRLeadStageRequest! (Non-null)
  Response:
    Returns: CRLeadStage
```

--------------------------------

### GraphQL crJobCreate Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crJobCreate

Detailed API documentation for the `crJobCreate` GraphQL mutation, outlining its required input arguments and the structure of its response.

```APIDOC
crJobCreate Mutation:
  Description: Create CRJob
  Arguments:
    language: Language
    request: CRJobRequest! (Non-null)
  Response:
    Returns: CRJob
```

--------------------------------

### GraphQL Query: crTemplatePartLinkPage Definition

Source: https://docs.carerix.io/graphql/welcome/queries/crTemplatePartLinkPage

Documentation for the crTemplatePartLinkPage GraphQL query, including its arguments, directives, and return type.

```APIDOC
crTemplatePartLinkPage Query
  Description: Read page of CRTemplatePartLink
  Directives:
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost(value: 0.005)
  Arguments:
    language: Language
    norestrict: Boolean
      Description: show previously deleted records; false - don't show deleted records.
      Default: false.
    pageable: Pageable
      Description: Page number and size of the page.
      Default: size - 20, page - 0.
    qualifier: String
  Response: CRTemplatePartLinkPage
```

--------------------------------

### GraphQL: frontendSettingPage Query Definition

Source: https://docs.carerix.io/graphql/welcome/queries/frontendSettingPage

Defines the `frontendSettingPage` GraphQL query, including its input arguments and the structure of its response.

```APIDOC
frontendSettingPage Query:
  Description: Read page of settings
  Arguments:
    filter:
      Type: String
      Description: Filtering predicate. Currently doesn't have any effect.
    pageable:
      Type: Pageable
  Response:
    Type: FrontendSettingPage
```

--------------------------------

### GraphQL crEmployeeCreate Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crEmployeeCreate

Detailed API documentation for the `crEmployeeCreate` GraphQL mutation, including its input arguments and their types, descriptions, and the structure of the expected response.

```APIDOC
crEmployeeCreate Mutation:
  Description: Create CREmployee
  Arguments:
    dedupe:
      Type: Boolean
      Description: Enables employee de-duplication. When true, deduplication is enabled. Defaults to false.
    language:
      Type: Language
    request:
      Type: CREmployeeRequest!
      Description: Non-null
  Response: CREmployee
```

--------------------------------

### API Documentation for IdentityProviderGoogleConfiguration Object

Source: https://docs.carerix.io/graphql/welcome/types/IdentityProviderGoogleConfiguration

Details the structure and usage of the IdentityProviderGoogleConfiguration object, including its fields and references within the Carerix GraphQL API.

```APIDOC
IdentityProviderGoogleConfiguration Object:
  Description: Google-specific configuration options for an identity provider.
  Fields:
    hostedDomain:
      Type: String
      Description: GSuite domain name to restrict login options.
  Usages:
    References:
      - Field 'google' from IdentityProvider
```

--------------------------------

### GraphQL Mutation: crToDoSentEmployeeViewCreate APIDOC

Source: https://docs.carerix.io/graphql/welcome/mutations/crToDoSentEmployeeViewCreate

API documentation for the crToDoSentEmployeeViewCreate GraphQL mutation, detailing its arguments and response type.

```APIDOC
Mutation: crToDoSentEmployeeViewCreate
Arguments:
  language: Language
  request: CRToDoSentEmployeeViewRequest ! (Non-null)
Response:
  Returns: CRToDoSentEmployeeView
```

--------------------------------

### oAuth2ClientPage GraphQL Query API Reference

Source: https://docs.carerix.io/graphql/welcome/queries/oAuth2ClientPage

Detailed API documentation for the oAuth2ClientPage GraphQL query, including its input arguments and the structure of its response.

```APIDOC
Query: oAuth2ClientPage
  Description: Retrieve a page of OAuth2 clients.
  Arguments:
    filter:
      Type: String
      Description: Filtering predicate.
    pageable:
      Type: Pageable
  Response: OAuth2ClientPage
```

--------------------------------

### GraphQL rolePage Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/rolePage

Detailed API documentation for the `rolePage` GraphQL query, including its arguments, their types and descriptions, and the expected return type.

```APIDOC
rolePage Query:
  Description: Fetch a page of roles with optional filtering.
  Arguments:
    filter:
      Type: String
      Description: Filter roles based on attributes like 'active' or 'assignableToAdditionalUsers'. Examples: 'active eq true', 'assignableToAdditionalUsers eq false'.
    pageable:
      Type: Pageable
      Description: Pagination options for the query.
  Returns: RolePage
```

--------------------------------

### GraphQL Mutation: crVacancyUserCreate API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crVacancyUserCreate

Detailed API documentation for the crVacancyUserCreate GraphQL mutation, including its purpose, arguments, return type, and associated directives.

```APIDOC
crVacancyUserCreate Mutation
  Description: Create CRVacancyUser
  Directives: @anyScope @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/crvacancy:manage"])
  Arguments:
    language:
      Type: Language
    request:
      Type: CRVacancyUserRequest!
      Constraint: Non-null
  Response:
    Returns: CRVacancyUser
```

--------------------------------

### GraphQL identityProviderPage Query API Reference

Source: https://docs.carerix.io/graphql/welcome/queries/identityProviderPage

Detailed documentation for the `identityProviderPage` GraphQL query, including its arguments and expected response type.

```APIDOC
identityProviderPage Query:
  Description: Retrieve a page of identity providers configured for a tenant.
  Arguments:
    filter:
      Type: String
      Description: Filtering predicate. Currently doesn't have any effect.
    pageable:
      Type: Pageable
  Returns: IdentityProviderPage
```

--------------------------------

### GraphQL crOpportunityUser Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crOpportunityUser

Detailed API documentation for the `crOpportunityUser` GraphQL query, including its arguments, return type, and associated directives.

```APIDOC
Query: crOpportunityUser
  Description: Read CROpportunityUser by id
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - _id: ID! (Non-null)
    - language: Language
  Returns: CROpportunityUser
```

--------------------------------

### GraphQL Query: crTalentPoolMatchStageTemplateReferencePage

Source: https://docs.carerix.io/graphql/welcome/queries/crTalentPoolMatchStageTemplateReferencePage

Detailed API documentation for the `crTalentPoolMatchStageTemplateReferencePage` GraphQL query, including its directives, input arguments with their types and descriptions, and the expected return type.

```APIDOC
Query: crTalentPoolMatchStageTemplateReferencePage
  Description: Read page of CRTalentPoolMatchStageTemplateReference
  Directives:
    @anyScope @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost @cost(value: 0.005)
  Arguments:
    language: Language
    norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier: String
  Returns: CRTalentPoolMatchStageTemplateReferencePage
```

--------------------------------

### GraphQL Mutation: crVacancyEducationCreate API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crVacancyEducationCreate

Detailed API documentation for the crVacancyEducationCreate GraphQL mutation, including its arguments and expected response type.

```APIDOC
crVacancyEducationCreate Mutation:
  Description: Create CRVacancyEducation
  Arguments:
    language: Language
    request: CRVacancyEducationRequest! (Non-null)
  Response:
    Returns CRVacancyEducation
```

--------------------------------

### GraphQL talentpool Query Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/talentpool

Documents the `talentpool` GraphQL query, detailing its arguments and expected response type for reading talent pool data by ID.

```APIDOC
talentpool Query:
  Description: Read talentpool by id
  Arguments:
    _id:
      Type: ID!
      Description: Non-null
  Response:
    Type: Talentpool
```

--------------------------------

### GraphQL Query: crPurchaseInvoiceInvoiceLinePage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crPurchaseInvoiceInvoiceLinePage

Detailed API documentation for the `crPurchaseInvoiceInvoiceLinePage` GraphQL query, outlining its input arguments, their types, descriptions, default values, and the structure of the returned response. Includes information on applied directives like `@anyScope` and `@cost`.

```APIDOC
crPurchaseInvoiceInvoiceLinePage Query
  Directives:
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost(value: 0.005)
  Arguments:
    language: Language
    norestrict: Boolean
      Description: show previously deleted records; false - don't show deleted records.
      Default: false
    pageable: Pageable
      Description: Page number and size of the page.
      Default: size - 20, page - 0
    qualifier: String
  Response: CRPurchaseInvoiceInvoiceLinePage
```

--------------------------------

### GraphQL Mutation: crMatchAttachmentCreate API Reference

Source: https://docs.carerix.io/graphql/welcome/mutations/crMatchAttachmentCreate

Comprehensive API documentation for the `crMatchAttachmentCreate` GraphQL mutation, detailing its purpose, arguments, and return type.

```APIDOC
Mutation: crMatchAttachmentCreate
  Description: Create CRMatchAttachment
  Scope: @anyScope @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/crmatch:manage"])
  Arguments:
    language:
      Type: Language
    request:
      Type: CRMatchAttachmentRequest!
      Constraint: Non-null
  Response:
    Returns: CRMatchAttachment
```

--------------------------------

### GraphQL Query: crHourPage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crHourPage

Detailed API documentation for the `crHourPage` GraphQL query, outlining its arguments, their types and descriptions, and the query's return type.

```APIDOC
crHourPage Query:
  Description: Read page of CRHour
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    language:
      Type: Language
    norestrict:
      Type: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable:
      Type: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier:
      Type: String
  Response:
    Returns: CRHourPage
```

--------------------------------

### GraphQL Mutation: crResourceCreate API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crResourceCreate

Detailed API documentation for the crResourceCreate GraphQL mutation, outlining its purpose, required arguments, and the structure of its response.

```APIDOC
crResourceCreate Mutation
  Description: Create CRResource
  Arguments:
    language: Language
    request: CRResourceRequest ! (Non-null)
  Response:
    Returns CRResource
```

--------------------------------

### GraphQL crLeadAttachmentCreate Mutation API Reference

Source: https://docs.carerix.io/graphql/welcome/mutations/crLeadAttachmentCreate

Detailed API documentation for the crLeadAttachmentCreate mutation, including its arguments and expected response type.

```APIDOC
Mutation: crLeadAttachmentCreate
Description: Create CRLeadAttachment

Arguments:
  language: Language
  request: CRLeadAttachmentRequest! (Non-null)

Response:
  Returns: CRLeadAttachment
```

--------------------------------

### PlacementPage Object API Reference

Source: https://docs.carerix.io/graphql/welcome/types/PlacementPage

Defines the structure and available fields of the `PlacementPage` object in the GraphQL API, including pagination details and its relation to other API resources.

```APIDOC
PlacementPage Object:
  Description: Page of placements
  Fields:
    first:
      Type: Boolean
      Description: Whether there are no previous pages.
    items:
      Type: [Placement]
      Description: Page items
    last:
      Type: Boolean
      Description: Whether there are no next pages.
    numberOfElements:
      Type: Int
      Description: Number of records in this particular page.
    page:
      Type: Int
      Description: Page number, starting from zero.
    size:
      Type: Int
      Description: Maximum number of records in one page.
    sort:
      Type: String
      Description: Sort expression that was used to get this page of records.
    totalElements:
      Type: Int
      Description: Total available number of records.
    totalPages:
      Type: Int
      Description: Total available pages, given current page size.
  Interfaces:
    Implements: APIResourcePage
  Usages:
    References:
      - Field placementPage from Query
```

--------------------------------

### GraphQL crOpportunityCreate Mutation Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crOpportunityCreate

Documents the `crOpportunityCreate` GraphQL mutation, detailing its arguments and return type for creating a CROpportunity. It specifies the input parameters like `language` and `request`, and the expected `CROpportunity` object as a response.

```APIDOC
Mutation: crOpportunityCreate
Description: Create CROpportunity
Arguments:
  language: Language
  request: CROpportunityRequest! (Non-null)
Response:
  Returns: CROpportunity
```

--------------------------------

### crLeadCreate GraphQL Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/crLeadCreate

Detailed API specification for the `crLeadCreate` mutation, including its arguments and the type of object it returns upon successful execution.

```APIDOC
Mutation: crLeadCreate
Purpose: Create CRLead

Arguments:
  language: Language
  request: CRLeadRequest! (Non-null)

Response:
  Returns: CRLead
```

--------------------------------

### GraphQL AiPromptPage Object Definition

Source: https://docs.carerix.io/graphql/welcome/types/AiPromptPage

Defines the structure and fields of the `AiPromptPage` object, used for paginating AI prompts. It includes pagination metadata like page number, size, total elements, and a list of `AiPrompt` items, and implements the `APIResourcePage` interface.

```APIDOC
AiPromptPage Object:
  Description: Page of AI Prompts
  Fields:
    first: Boolean - Whether there are no previous pages.
    items: [AiPrompt] - Page Items
    last: Boolean - Whether there are no next pages.
    numberOfElements: Int - Number of records in this particular page.
    page: Int - Page number, starting from zero.
    size: Int - Maximum number of records in one page.
    sort: String - Sort expression that was used to get this page of records.
    totalElements: Int - Total available number of records.
    totalPages: Int - Total available pages, given current page size.
  Interfaces:
    - APIResourcePage
  Usages:
    References:
      - Field aiPromptPage from Query
```

--------------------------------

### GraphQL Query: crInvoiceLinePage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crInvoiceLinePage

Detailed API documentation for the `crInvoiceLinePage` GraphQL query, outlining its purpose, arguments, and expected response type.

```APIDOC
Query: crInvoiceLinePage
  Description: Read page of CRInvoiceLine
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - name: language
      type: Language
      description: ""
    - name: norestrict
      type: Boolean
      description: "true - show previously deleted records; false - don't show deleted records. Default: false."
    - name: pageable
      type: Pageable
      description: "Page number and size of the page. Default: size - 20, page - 0."
    - name: qualifier
      type: String
      description: ""
  Response:
    type: CRInvoiceLinePage
```

--------------------------------

### GraphQL Query: crEditionArticlePage

Source: https://docs.carerix.io/graphql/welcome/queries/crEditionArticlePage

Detailed API documentation for the `crEditionArticlePage` GraphQL query, including its input arguments and expected return type.

```APIDOC
Query: crEditionArticlePage
  Description: Read page of CREditionArticle
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - language:
        Type: Language
    - norestrict:
        Type: Boolean
        Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    - pageable:
        Type: Pageable
        Description: Page number and size of the page. Default: size - 20, page - 0.
    - qualifier:
        Type: String
  Response:
    Returns: CREditionArticlePage
```

--------------------------------

### GraphQL Query: crLeadAttachment API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crLeadAttachment

Detailed API documentation for the crLeadAttachment GraphQL query, including its purpose, arguments, return type, and associated directives.

```APIDOC
Query: crLeadAttachment
Description: Read CRLeadAttachment by id
Directives:
  - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
  - @cost(value: 0.005)
Arguments:
  _id: ID! (Non-null)
  language: Language
Returns: CRLeadAttachment
```

--------------------------------

### GraphQL Query: crOpportunityUserPage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crOpportunityUserPage

Detailed API documentation for the crOpportunityUserPage GraphQL query. It outlines the query's purpose, associated directives, accepted arguments with their types and descriptions, and the structure of the returned response.

```APIDOC
Query: crOpportunityUserPage
  Description: Read page of CROpportunityUser
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - language:
        Type: Language
    - norestrict:
        Type: Boolean
        Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    - pageable:
        Type: Pageable
        Description: Page number and size of the page. Default: size - 20, page - 0.
    - qualifier:
        Type: String
  Response:
    Type: CROpportunityUserPage
```

--------------------------------

### GraphQL Query Definition: crEmployeeTraining

Source: https://docs.carerix.io/graphql/welcome/queries/crEmployeeTraining

Defines the crEmployeeTraining GraphQL query, including its purpose, associated directives, required and optional arguments, and the expected return type.

```APIDOC
GraphQL Query: crEmployeeTraining
  Description: Read CREmployeeTraining by id
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/cremployee:manage", "urn:cx/cx5Wrapper:data/cremployee:read"])
    - @cost(value: 0.005)
  Arguments:
    - _id: ID! (Non-null)
    - language: Language
  Returns: CREmployeeTraining
```

--------------------------------

### GraphQL Query: crStatusInfoEmailTemplatesPage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crStatusInfoEmailTemplatesPage

Comprehensive documentation for the `crStatusInfoEmailTemplatesPage` GraphQL query, detailing its purpose, accepted arguments with their types and descriptions, and the structure of the returned response.

```APIDOC
crStatusInfoEmailTemplatesPage Query
  Description: Read page of CRStatusInfoEmailTemplates
  Directives:
    @anyScope
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost(value: 0.005)

  Arguments:
    language: Language
    norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier: String

  Response:
    Returns CRStatusInfoEmailTemplatesPage
```

--------------------------------

### crLeadPage GraphQL Query API Reference

Source: https://docs.carerix.io/graphql/welcome/queries/crLeadPage

Detailed API documentation for the crLeadPage GraphQL query, outlining its arguments, their types, descriptions, and the expected response type. Includes associated directives.

```APIDOC
crLeadPage Query:
  Description: Read page of CRLead
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - name: language
      type: Language
    - name: norestrict
      type: Boolean
      description: "true - show previously deleted records; false - don't show deleted records. Default: false."
    - name: pageable
      type: Pageable
      description: "Page number and size of the page. Default: size - 20, page - 0."
    - name: qualifier
      type: String
  Response:
    - type: CRLeadPage
```

--------------------------------

### GraphQL Query: crLeadStageEmailTemplatePage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crLeadStageEmailTemplatePage

Detailed API documentation for the crLeadStageEmailTemplatePage GraphQL query, outlining its purpose, accepted arguments with their types and descriptions, and the structure of the returned data.

```APIDOC
crLeadStageEmailTemplatePage Query:
  Description: Read page of CRLeadStageEmailTemplate
  Directives:
    @anyScope: names = ["urn:cx/cx5Wrapper:data:manage"]
    @cost: value = 0.005
  Arguments:
    language: Language
    norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier: String
  Response: CRLeadStageEmailTemplatePage
```

--------------------------------

### crMonthHourJobViewPage GraphQL Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crMonthHourJobViewPage

Comprehensive documentation for the `crMonthHourJobViewPage` GraphQL query, outlining its arguments, their types and descriptions, associated directives, and the expected return type.

```APIDOC
crMonthHourJobViewPage Query
  Description: Read page of CRMonthHourJobView
  Directives:
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost(value: 0.005)
  Arguments:
    language: Language
    norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier: String
  Response: CRMonthHourJobViewPage
```

--------------------------------

### GraphQL Query: crLeadGroupPage

Source: https://docs.carerix.io/graphql/welcome/queries/crLeadGroupPage

Documentation for the crLeadGroupPage GraphQL query, including its arguments, their types, and the expected response.

```APIDOC
crLeadGroupPage Query
  Description: Read page of CRLeadGroup
  Directives:
    @anyScope
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost
    @cost(value: 0.005)
  Arguments:
    language:
      Type: Language
    norestrict:
      Type: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    pageable:
      Type: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    qualifier:
      Type: String
  Response:
    Returns: CRLeadGroupPage
```

--------------------------------

### GraphQL identityProviderCreate Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/identityProviderCreate

Detailed API documentation for the identityProviderCreate GraphQL mutation, including its arguments, types, and return value. This mutation is used to create a new identity provider.

```APIDOC
Mutation: identityProviderCreate
  Description: Create a new identity provider.
  Directives:
    - @anyScope
    - @anyScope(names: ["urn:cx/tenants:data/tenants:update"])
  Arguments:
    metadata:
      Type: Upload
      Description: Additional configuration metadata
    request:
      Type: IdentityProviderRequest! (Non-null)
      Description: Identity provider configuration
  Response:
    Returns: IdentityProvider
```

--------------------------------

### crVacancyTrainingPage GraphQL Query API Specification

Source: https://docs.carerix.io/graphql/welcome/queries/crVacancyTrainingPage

Detailed API specification for the `crVacancyTrainingPage` GraphQL query, including its arguments, their types and descriptions, associated directives, and the expected return type.

```APIDOC
Query: crVacancyTrainingPage
Description: Read page of CRVacancyTraining
Directives:
  - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/crvacancy:read", "urn:cx/cx5Wrapper:data/crvacancy:manage"])
  - @cost(value: 0.005)
Arguments:
  - name: language
    type: Language
  - name: norestrict
    type: Boolean
    description: true - show previously deleted records; false - don't show deleted records. Default: false.
  - name: pageable
    type: Pageable
    description: Page number and size of the page. Default: size - 20, page - 0.
  - name: qualifier
    type: String
Response:
  - type: CRVacancyTrainingPage
```

--------------------------------

### GraphQL Query: crVacancyAttachment API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crVacancyAttachment

Detailed API documentation for the crVacancyAttachment GraphQL query, including its description, directives, arguments, and return type.

```APIDOC
Query: crVacancyAttachment
  Description: Read CRVacancyAttachment by id
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/crvacancy:read", "urn:cx/cx5Wrapper:data/crvacancy:manage"])
    - @cost(value: 0.005)
  Arguments:
    - _id: ID! (Non-null)
    - language: Language
  Returns: CRVacancyAttachment
```

--------------------------------

### aiPromptDelete GraphQL Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/aiPromptDelete

Documentation for the `aiPromptDelete` GraphQL mutation, detailing its arguments and expected response type.

```APIDOC
Mutation: aiPromptDelete
  Description: Delete AI Prompt by id
  Arguments:
    _id:
      Type: ID!
      Description: Non-null
  Response: DeleteResponse
```

--------------------------------

### GraphQL Query: crNotePage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crNotePage

Detailed API documentation for the `crNotePage` GraphQL query, outlining its purpose, supported directives, input arguments with their types and descriptions, and the expected return type.

```APIDOC
crNotePage Query:
  Description: Read page of CRNote
  Directives:
    - @anyScope
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost
    - @cost(value: 0.005)
  Arguments:
    - name: language
      type: Language
      description: ""
    - name: norestrict
      type: Boolean
      description: "true - show previously deleted records; false - don't show deleted records. Default: false."
    - name: pageable
      type: Pageable
      description: "Page number and size of the page. Default: size - 20, page - 0."
    - name: qualifier
      type: String
      description: ""
  Response:
    type: CRToDoPage
```

--------------------------------

### GraphQL userExecuteActions Mutation API Documentation

Source: https://docs.carerix.io/graphql/welcome/mutations/userExecuteActions

Documentation for the `userExecuteActions` GraphQL mutation, which sends an email to a user with a link to perform specified actions. It details the required arguments and the expected return type.

```APIDOC
Mutation: userExecuteActions
  Description: Sends an email to user with the link to perform a list of required actions.
  Arguments:
    _id: ID! (Non-null)
    actions: [String]! (Non-null)
  Response:
    Returns: ID
```

--------------------------------

### GraphQL Mutation: crToDoSentContactViewCreate API Reference

Source: https://docs.carerix.io/graphql/welcome/mutations/crToDoSentContactViewCreate

Detailed API documentation for the `crToDoSentContactViewCreate` GraphQL mutation, including its arguments, types, and return value.

```APIDOC
crToDoSentContactViewCreate Mutation:
  Description: Create CRToDoSentContactView
  Arguments:
    language: Language
    request: CRToDoSentContactViewRequest! (Non-null)
  Response:
    Returns CRToDoSentContactView
```

--------------------------------

### crConfigProfilePage GraphQL Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crConfigProfilePage

Comprehensive documentation for the crConfigProfilePage GraphQL query, including its associated directives, input arguments with their types and descriptions, and the expected return type.

```APIDOC
crConfigProfilePage Query
  Description: Read page of CRConfigProfile
  Directives:
    - @anyScope (names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost (value: 0.005)
  Arguments:
    - language: Language
    - norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    - pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    - qualifier: String
  Response: CRConfigProfilePage
```

--------------------------------

### GraphQL Query: crEmployeeTrainingPage API Definition

Source: https://docs.carerix.io/graphql/welcome/queries/crEmployeeTrainingPage

Defines the `crEmployeeTrainingPage` GraphQL query, including its arguments, directives, and the structure of its response for reading pages of CREmployeeTraining records.

```APIDOC
Query: crEmployeeTrainingPage
  Description: Read page of CREmployeeTraining
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage", "urn:cx/cx5Wrapper:data/cremployee:manage", "urn:cx/cx5Wrapper:data/cremployee:read"])
    - @cost(value: 0.005)
  Arguments:
    - name: language
      type: Language
      description: ""
    - name: norestrict
      type: Boolean
      description: "true - show previously deleted records; false - don't show deleted records. Default: false."
    - name: pageable
      type: Pageable
      description: "Page number and size of the page. Default: size - 20, page - 0."
    - name: qualifier
      type: String
      description: ""
  Response:
    type: CREmployeeTrainingPage
```

--------------------------------

### crLeadStageTemplateReferencePage GraphQL Query API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crLeadStageTemplateReferencePage

Detailed API documentation for the crLeadStageTemplateReferencePage GraphQL query, including its arguments and expected response type.

```APIDOC
Query: crLeadStageTemplateReferencePage
  Description: Read page of CRLeadStageTemplateReference
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - language: Language
    - norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    - pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    - qualifier: String
  Response:
    Returns: CRLeadStageTemplateReferencePage
```

--------------------------------

### GraphQL Query: crToDoResourcePage

Source: https://docs.carerix.io/graphql/welcome/queries/crToDoResourcePage

Detailed API documentation for the `crToDoResourcePage` GraphQL query, including its arguments, types, and return value.

```APIDOC
Query: crToDoResourcePage
  Description: Read page of CRToDoResource
  Directives:
    - @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    - @cost(value: 0.005)
  Arguments:
    - language: Language
    - norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records. Default: false.
    - pageable: Pageable
      Description: Page number and size of the page. Default: size - 20, page - 0.
    - qualifier: String
  Response: CRToDoResourcePage
```

--------------------------------

### GraphQL Query: crMeetingPage API Documentation

Source: https://docs.carerix.io/graphql/welcome/queries/crMeetingPage

Documents the `crMeetingPage` GraphQL query, including its purpose, associated directives, accepted arguments with their types and descriptions, and the expected response type.

```APIDOC
crMeetingPage Query
  Description: Read page of CRMeeting
  Directives:
    @anyScope(names: ["urn:cx/cx5Wrapper:data:manage"])
    @cost(value: 0.005)
  Arguments:
    language: Language
    norestrict: Boolean
      Description: true - show previously deleted records; false - don't show deleted records.
      Default: false
    pageable: Pageable
      Description: Page number and size of the page.
      Default: size - 20, page - 0
    qualifier: String
  Response:
    CRToDoPage
```