> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a custom list

> Creates a custom list. Records are added to its working set and become screenable only after a publish and an activation. Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. **Workspace scoped** and **Tenant scoped** keys are refused with 403. The `x-user-token` scheme is the Minerva dashboard session token; with it, writes require an owner or admin.



## OpenAPI

````yaml /api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}
openapi: 3.0.0
info:
  version: 1.0.0
  title: MinervaAI Admin API
  description: Admin endpoints for the Minerva application suite.
servers:
  - url: https://api.gominerva.com
    description: The production API server for Minerva.
security:
  - ApiKeyAuth: []
tags: []
paths:
  /custom-lists/v2/organizations/{orgId}:
    post:
      tags:
        - Custom Lists
      summary: Create a custom list
      description: >-
        Creates a custom list. Records are added to its working set and become
        screenable only after a publish and an activation. Requires an admin API
        key, the **Admin (tenant-wide)** key type, which only an owner or admin
        of this organization can create. **Workspace scoped** and **Tenant
        scoped** keys are refused with 403. The `x-user-token` scheme is the
        Minerva dashboard session token; with it, writes require an owner or
        admin.
      parameters:
        - in: path
          name: orgId
          required: true
          schema:
            type: string
          description: >-
            The organization (tenant) id. Must equal the tenant of the admin
            key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomListCreateRequest'
            examples:
              create:
                summary: Create a list with a fixed record id column.
                value:
                  name: Offboarded clients
                  description: Clients we no longer do business with
                  default_feed_category: internal
                  record_id_column: record_uid
                  risk_score_impact: 0
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListResponse'
              examples:
                created:
                  summary: The list was created.
                  value:
                    data:
                      id: 3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c
                      tenant_id: 123e4567-e89b-12d3-a456-426614174000
                      name: Offboarded clients
                      description: Clients we no longer do business with
                      status: active
                      schema_version: 1
                      record_id_column: record_uid
                      default_feed_category: internal
                      risk_score_impact: 0
                      created_by: 64b1c0de00000000000000a1
                      created_at: '2026-11-05T01:20:05.346Z'
                      updated_at: '2026-11-05T01:20:05.346Z'
        '400':
          description: >-
            Invalid request: a required field is missing or a value is invalid.
            Some validation errors (for example `name is required.`) are plain
            text; others (`error` is `validation_failed`) are a JSON
            `CustomListError`. Branch on `Content-Type`.
          content:
            text/plain:
              schema:
                type: string
                example: name is required.
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                validation:
                  summary: Validation failed.
                  value:
                    error: validation_failed
                    message: 'custom-list: validation failed: name is required'
        '403':
          description: >-
            No credentials were sent; the API key was revoked, has expired, or
            its application is deactivated (`API-key authentication was
            denied.`); the key is not an admin application key (**Workspace
            scoped** and **Tenant scoped** keys are refused); it belongs to
            another organization; or its creator is no longer an owner or admin.
            For a user token, the user is not a member, or is not an owner or
            admin on a write. If the tenant is not entitled to custom lists, the
            body is a JSON `CustomListError` with `error: not_enabled` (`Custom
            lists are not enabled for this tenant.`); every other 403 is plain
            text. Branch on `Content-Type`.
          content:
            text/plain:
              schema:
                type: string
                example: 'Missing Authorization: Api-Key or x-api-key header.'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                not-enabled:
                  summary: Tenant not entitled.
                  value:
                    error: not_enabled
                    message: Custom lists are not enabled for this tenant.
        '404':
          description: >-
            Custom list management is not enabled (`Custom list management is
            not enabled.`); the list, record, upload, job or workspace is not in
            this organization; or the application API key (`mrva-…`) is unknown
            (`API-key authentication was denied.`).
          content:
            text/plain:
              schema:
                type: string
                example: Custom list management is not enabled.
        '422':
          description: >-
            A tenant custom-list entitlement limit would be exceeded. JSON
            `CustomListError` with `error: limit_exceeded`, `limit` naming the
            limit (`maxCustomListsPerTenant`) and `max` the configured maximum.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                list-limit:
                  summary: The tenant already has its maximum number of lists.
                  value:
                    error: limit_exceeded
                    limit: maxCustomListsPerTenant
                    max: 100
        '503':
          description: >-
            The authentication service is temporarily unavailable
            (`Authentication service is unavailable.`). Nothing was changed;
            retry with backoff.
          content:
            text/plain:
              schema:
                type: string
                example: Authentication service is unavailable.
      security:
        - AdminApiKeyAuth: []
        - UserTokenAuth: []
components:
  schemas:
    CustomListCreateRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: string
        default_feed_category:
          type: string
          enum:
            - internal
            - sanctions
            - pep
            - news
            - legal
            - criminal
        record_id_column:
          type: string
          description: Upload column holding each record id. Fixed once created.
        risk_score_impact:
          type: integer
          minimum: 0
          maximum: 100
    CustomListResponse:
      type: object
      description: '`{ data: CustomList }`'
      properties:
        data:
          $ref: '#/components/schemas/CustomList'
      required:
        - data
    CustomListError:
      type: object
      properties:
        error:
          type: string
          description: >-
            Machine-readable code, e.g. `validation_failed`, `limit_exceeded`,
            `conflict`, `not_enabled`, `upload_capacity_exceeded`,
            `upload_request_timeout`.
        message:
          type: string
        limit:
          type: string
          description: >-
            For `limit_exceeded`: the entitlement limit, e.g.
            `maxRecordsPerList`.
        max:
          type: integer
          description: 'For `limit_exceeded`: the configured maximum.'
        retryable:
          type: boolean
      additionalProperties: true
    CustomList:
      type: object
      properties:
        id:
          type: string
        tenant_id:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
            - active
            - archived
        schema_version:
          type: integer
        record_id_column:
          type: string
        default_feed_category:
          type: string
          enum:
            - internal
            - sanctions
            - pep
            - news
            - legal
            - criminal
        risk_score_impact:
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            How much a match against this list raises the Client Risk Rating
            (CRR): 0 = no effect, 100 = rates the client High immediately.
        created_by:
          type: string
          description: >-
            The actor that created the list: a user id, or the admin application
            id for a key request.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - tenant_id
        - name
        - description
        - status
        - schema_version
        - record_id_column
        - default_feed_category
        - risk_score_impact
        - created_by
        - created_at
        - updated_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Admin API key for authentication. Manage API keys in the Minerva
        dashboard under Administration > Developers.
    AdminApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        An admin application key: `Authorization: Api-Key <token>` (or legacy
        `x-api-key`). Only tenant owners and admins can create one. Standard
        keys are refused with 403 on workspace management and tenant
        configuration routes.
    UserTokenAuth:
      type: apiKey
      in: header
      name: x-user-token
      description: Firebase user token for authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.