AppOmni Value List API

openapi: 3.2.0
info:
  title: AppOmni Monitored Services Value List API
  description: 'Registration and administration of monitored SaaS services, their custom fields, custom field values, tags and value lists.


    Derived faithfully from the AppOmni public Postman collection published by AppOmni at https://api.appomni.com/ — every path, method, parameter, request body and example response below is taken verbatim from that collection. No operation was invented.'
  version: 1.0.0
  contact:
    name: AppOmni
    url: https://appomni.com/support/
  license:
    name: Proprietary
    url: https://appomni.com/terms-of-service/
  x-generated-from: AppOmni public Postman collection (publishedId 2sBXc7Mjib, published 2026-02-04)
  x-generated-source: https://api.appomni.com/api/collections/45135595/2sBXc7Mjib?segregateAuth=true&versionTag=latest
  x-generated-method: derived
  x-generated-date: '2026-09-04'
servers:
- url: https://{instance}.appomni.com
  description: AppOmni tenant. Replace {instance} with your AppOmni subdomain — e.g. `acme` if you log in at acme.appomni.com.
  variables:
    instance:
      default: example
      description: Your AppOmni tenant subdomain
security:
- bearerAuth: []
tags:
- name: ValueList
  description: 'ValueList and ValueListElement are used to manage lists of items used by Insights. ValueLists have a type designation and will be used by Insights on convention based on their type.


    Overview


    - ValueList : A container for a list of values with a specific type and usage


    - ValueListElement : Individual items within a ValueList'
paths:
  /api/v1/core/valuelist/:
    get:
      operationId: listValueLists
      summary: List Value Lists
      tags:
      - ValueList
      description: 'Returns a list of value lists.


        Response Fields


        Field

        Data Type

        Description

        Example


        id

        Integer

        Unique identifier for the value list

        1


        name

        String

        Name of the value list

        "Power Platform Domains"


        list_type

        String

        Type of values in the list

        "strings"


        list_usage

        String

        Usage identifier for the list

        "o365_power_platform_domains"


        description

        String

        Description of the value list

        "List of Power Platform domains"


        element_count

        Integer

        Number of elements in the list

        5


        created

        String (ISO datetime)

        Creation timestamp

        "2024-09-24T10:00:00Z"


        modified

        String (ISO datetime)

        Last modification timestamp

        "2024-09-24T10:00:00Z"


        created_by

        String

        User who created the list

        " admin@example.com "


        modified_by

        String

        User who last modified the list

        " admin@example.com "'
      parameters:
      - name: limit
        in: query
        required: false
        description: Query parameter limit
        schema:
          type: integer
        example: '50'
      - name: offset
        in: query
        required: false
        description: Query parameter offset
        schema:
          type: integer
        example: '0'
      - name: ordering
        in: query
        required: false
        description: Query parameter ordering
        schema:
          type: string
        example: name
      - name: search
        in: query
        required: false
        description: Query parameter search
        schema:
          type: string
        example: power
      - name: list_type
        in: query
        required: false
        description: Query parameter list_type
        schema:
          type: string
        example: strings
      - name: list_usage
        in: query
        required: false
        description: Query parameter list_usage
        schema:
          type: string
        example: o365_power_platform_domains
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized — missing or invalid AppOmni API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the token lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createValueList
      summary: Create Value List
      tags:
      - ValueList
      description: 'Creates a new value list.


        Request Body Documentation


        Field

        Data Type

        Required

        Description

        Example


        name

        String

        Yes

        Name of the value list

        "Power Platform Domains"


        list_type

        String

        Yes

        Type of values in the list

        "strings"


        list_usage

        String

        Yes

        Usage identifier for the list

        "o365_power_platform_domains"


        description

        String

        No

        Description of the value list

        "List of Power Platform domains"


        Response Fields


        Field

        Data Type

        Description

        Example


        id

        Integer

        Unique identifier for the value list

        1


        name

        String

        Name of the value list

        "Power Platform Domains"


        list_type

        String

        Type of values in the list

        "strings"


        list_usage

        String

        Usage identifier for the list

        "o365_power_platform_domains"


        description

        String

        Description of the value list

        "List of Power Platform domains"


        element_count

        Integer

        Number of elements in the list

        0


        created

        String (ISO datetime)

        Creation timestamp

        "2024-09-24T10:00:00Z"


        modified

        String (ISO datetime)

        Last modification timestamp

        "2024-09-24T10:00:00Z"


        created_by

        String

        User who created the list

        " admin@example.com "


        modified_by

        String

        User who last modified the list

        " admin@example.com "'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              name: Power Platform Domains
              list_type: strings
              list_usage: o365_power_platform_domains
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized — missing or invalid AppOmni API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the token lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/core/valuelistelement/:
    get:
      operationId: listValueListElements
      summary: List Value List Elements
      tags:
      - ValueList
      description: 'Returns a list of value list elements.


        Response Fields


        Field

        Data Type

        Description

        Example


        id

        Integer

        Unique identifier for the element

        1


        parent

        Integer

        ID of the parent value list

        1


        element_type

        String

        Type of the element value

        "strings"


        value

        String

        The actual value of the element

        " https://a_customer_domain.crm.dynamics.com"


        created

        String (ISO datetime)

        Creation timestamp

        "2024-09-24T10:00:00Z"


        modified

        String (ISO datetime)

        Last modification timestamp

        "2024-09-24T10:00:00Z"


        created_by

        String

        User who created the element

        " admin@example.com "


        modified_by

        String

        User who last modified the element

        " admin@example.com "'
      parameters:
      - name: limit
        in: query
        required: false
        description: Query parameter limit
        schema:
          type: integer
        example: '50'
      - name: offset
        in: query
        required: false
        description: Query parameter offset
        schema:
          type: integer
        example: '0'
      - name: ordering
        in: query
        required: false
        description: Query parameter ordering
        schema:
          type: string
        example: value
      - name: parent
        in: query
        required: false
        description: Query parameter parent
        schema:
          type: string
      - name: element_type
        in: query
        required: false
        description: Query parameter element_type
        schema:
          type: string
        example: strings
      - name: value__icontains
        in: query
        required: false
        description: Query parameter value__icontains
        schema:
          type: string
        example: dynamics
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized — missing or invalid AppOmni API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the token lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createValueListElement
      summary: Create Value List Element
      tags:
      - ValueList
      description: 'Creates a new value list element.


        Request Body Documentation


        Field

        Data Type

        Required

        Description

        Example


        parent

        Integer

        Yes

        ID of the parent value list

        {{valuelist_id}}


        element_type

        String

        Yes

        Type of the element value

        "strings"


        value

        String

        Yes

        The actual value of the element

        " https://example.crm.dynamics.com"


        Response Fields


        Field

        Data Type

        Description

        Example


        id

        Integer

        Unique identifier for the element

        2


        parent

        Integer

        ID of the parent value list

        1


        element_type

        String

        Type of the element value

        "strings"


        value

        String

        The actual value of the element

        " https://example.crm.dynamics.com"


        created

        String (ISO datetime)

        Creation timestamp

        "2024-09-24T10:00:00Z"


        modified

        String (ISO datetime)

        Last modification timestamp

        "2024-09-24T10:00:00Z"


        created_by

        String

        User who created the element

        " admin@example.com "


        modified_by

        String

        User who last modified the element

        " admin@example.com "'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example: "{\n    \"parent\": {{valuelist_id}},\n    \"element_type\": \"strings\",\n    \"value\": \"https://example.crm.dynamics.com\"\n}"
      responses:
        '200':
          description: Successful response
        '401':
          description: Unauthorized — missing or invalid AppOmni API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the token lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      title: Error
      description: Standard Django REST Framework error envelope returned by the AppOmni API.
      properties:
        detail:
          type: string
          description: Human readable error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'AppOmni API access token, created and managed in the AppOmni platform under Settings > API Settings. Sent as `Authorization: Bearer <token>`.'