> ## 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.

# Get list deployment status

> Reads the deployment status of the list's latest version (`pending`, `live` or `down`) and, with `workspace_id`, its activation in that workspace. Poll this after a publish until `deployment_status` is `live`. 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 get /custom-lists/v2/organizations/{orgId}/{listId}/status
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}/{listId}/status:
    get:
      tags:
        - Custom Lists
      summary: Get list deployment status
      description: >-
        Reads the deployment status of the list's latest version (`pending`,
        `live` or `down`) and, with `workspace_id`, its activation in that
        workspace. Poll this after a publish until `deployment_status` is
        `live`. 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.
        - in: path
          name: listId
          required: true
          schema:
            type: string
          description: The custom list id.
        - in: query
          name: workspace_id
          schema:
            type: string
          description: >-
            Optional workspace id in this organization. Without it the request
            uses the default workspace where one is needed. The `x-workspace-id`
            header is also accepted.
        - in: query
          name: feed_category
          schema:
            type: string
            enum:
              - internal
              - sanctions
              - pep
              - news
              - legal
              - criminal
          description: Optional feed category of the activation to report on.
        - in: query
          name: version_id
          schema:
            type: string
          description: Optional version id of the activation to report on.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListStatusResponse'
              examples:
                live:
                  summary: The latest version is deployed and live.
                  value:
                    data:
                      list_id: 3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c
                      latest_version_id: 4a3b2c1d-8e9f-4a6b-9c7d-6e5f4a3b2c1d
                      deployment_status: live
                      deploymentStatus: live
                      deploymentHealth: healthy
                      deployment_stage: live
                      workspace_activation_status: not_activated
                      active_version_id: 4a3b2c1d-8e9f-4a6b-9c7d-6e5f4a3b2c1d
                      feed_category: internal
                      updated_at: '2026-11-05T15:02:18.555Z'
                deploying:
                  summary: The version was published and is still deploying.
                  value:
                    data:
                      list_id: a09b8c7d-2e3f-4a0b-9c8d-ce1ba09b8c7d
                      latest_version_id: 4a3b2c1d-8e9f-4a6b-9c7d-6e5f4a3b2c1d
                      deployment_status: pending
                      deploymentStatus: pending
                      deploymentHealth: pending
                      deployment_stage: deploying
                      workspace_activation_status: activated
                      active_version_id: 4a3b2c1d-8e9f-4a6b-9c7d-6e5f4a3b2c1d
                      feed_category: internal
                      updated_at: '2026-11-05T01:18:56.664Z'
        '400':
          description: >-
            `feed_category` is not one of internal, sanctions, pep, news, legal,
            or criminal (`feedCategory must be one of …`). Plain text.
          content:
            text/plain:
              schema:
                type: string
                example: >-
                  feedCategory must be one of internal, sanctions, pep, news,
                  legal, or criminal.
        '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.
        '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:
    CustomListStatusResponse:
      type: object
      description: '`{ data: CustomListStatusInfo }`'
      properties:
        data:
          $ref: '#/components/schemas/CustomListStatusInfo'
      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
    CustomListStatusInfo:
      type: object
      properties:
        list_id:
          type: string
        latest_version_id:
          type: string
        deployment_status:
          type: string
          enum:
            - pending
            - live
            - down
          description: >-
            Poll until `live` before treating published changes as screened
            against.
        deploymentStatus:
          type: string
          enum:
            - pending
            - live
            - down
          description: Alias of `deployment_status`.
        deploymentHealth:
          type: string
          enum:
            - healthy
            - pending
            - unhealthy
            - unknown
        deployment_stage:
          type: string
        deployment_health:
          type: string
        deployment_job_id:
          type: string
        deployment_correlation_id:
          type: string
        deployment_failure_reason:
          type: string
        workspace_activation_status:
          type: string
          enum:
            - not_activated
            - activated
            - disabled
        active_version_id:
          type: string
        feed_category:
          type: string
          enum:
            - internal
            - sanctions
            - pep
            - news
            - legal
            - criminal
        updated_at:
          type: string
          format: date-time
      required:
        - list_id
        - deployment_status
        - deploymentStatus
        - deploymentHealth
        - deployment_stage
        - workspace_activation_status
        - 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.