AppZen Custom Data Sets API

The Custom Data Sets API from AppZen — 3 operation(s) for custom data sets.

Operations 3

POST /custom-data Creates/updates a custom data record
GET /custom-data/{uuid} Returns custom data record details
GET /custom-data/dataset-name/{dataset-name}/external-id/{custom-external-id} Returns custom data record details

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/appzen-custom-data-sets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

appzen-custom-data-sets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Autonomous AP APIs Chart of Accounts Custom Data Sets API
  description: Public APIs for integrating with Autonomous AP
  version: 2.0.3
servers:
- url: https://<env>.appzen.com/dictionary-data-services
security:
- API Key Header: []
  Customer Id Header: []
  Customer Key Header: []
tags:
- name: Custom Data Sets
paths:
  /custom-data:
    post:
      tags:
      - Custom Data Sets
      summary: Creates/updates a custom data record
      description: Creates a new Lookup in AppZen (set of named key  value pairs). Returns a uuid for this lookup. When there already exists a lookup (with the same lookup_name and external_id), then the operation is an update (in this case, the `status` in the response will be `UPDATED`).
      parameters:
      - $ref: '#/components/parameters/custom-data-json-schema'
      responses:
        200:
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uuid-updated'
        201:
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uuid'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-400-error-response'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-401-error-response'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-403-error-response'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-404-error-response'
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-500-error-response'
  /custom-data/{uuid}:
    get:
      tags:
      - Custom Data Sets
      summary: Returns custom data record details
      description: Returns the details of a custom data record by uuid
      parameters:
      - $ref: '#/components/parameters/uuid'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-data-get'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-400-error-response'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-401-error-response'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-403-error-response'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-404-error-response'
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-500-error-response'
  /custom-data/dataset-name/{dataset-name}/external-id/{custom-external-id}:
    get:
      tags:
      - Custom Data Sets
      summary: Returns custom data record details
      description: Returns the details of a custom data record matching the dataset-name and its external-id
      parameters:
      - $ref: '#/components/parameters/dataset-name'
      - $ref: '#/components/parameters/custom-external-id'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-data-get'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-400-error-response'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-401-error-response'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-403-error-response'
        404:
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-404-error-response'
        500:
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http-500-error-response'
components:
  schemas:
    http-403-error-response:
      type: object
      properties:
        timestamp:
          type: string
          example: 2019-01-17T16:12:45.977+0000
        status:
          type: string
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: 'Error code : 17e3338d - You do not have permission to access this resource'
    uuid:
      type: object
      properties:
        uuid:
          type: string
          example: 5fc03087-d265-11e7-b8c6-83e29cd24f4c
        status:
          type: string
          example: CREATED
    date-time:
      type: string
      format: date-time
      example: '2024-03-01T11:01:00Z'
      description: date should be in UTC format
    custom-data-get:
      properties:
        dataset_name:
          description: Data Set Name in the ERP system
          type: string
          example: Employee
        custom_external_id:
          example: E123
          description: Unique ID in the ERP system.
          type: string
        items:
          description: List of key value pairs belong to the custom data record.
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: The field name in the record
              value:
                type: string
                description: The value associated with the key
          example:
          - key: first_name
            value: Anand
          - key: last_name
            value: Vijian
        is_active:
          description: Is custom data record active in the ERP system.
          default: true
          type: boolean
        created_at:
          allOf:
          - $ref: '#/components/schemas/date-time'
        updated_at:
          allOf:
          - $ref: '#/components/schemas/date-time'
        uuid:
          type: string
          example: 0045-89707-0906-DE3C
    http-500-error-response:
      type: object
      properties:
        timestamp:
          type: string
          example: 2019-01-17T16:12:45.977+0000
        status:
          type: string
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: 'Error code : 17e3338d - Unable to process your request at this moment, please try again later'
    http-401-error-response:
      type: object
      properties:
        timestamp:
          type: string
          example: 2019-01-17T16:12:45.977+0000
        status:
          type: string
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: 'Error code : 17e3338d - Unable to authenticate credentials'
    custom-data:
      properties:
        dataset_name:
          description: Data Set Name from ERP system
          type: string
          example: Employee
        custom_external_id:
          example: E123
          description: Unique ID in the ERP system.
          type: string
        items:
          description: List of key value pairs belong to the custom data record.
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: The field name in the record
              value:
                type: string
                description: The value associated with the key
          example:
          - key: first_name
            value: Anand
          - key: last_name
            value: Vijian
        is_active:
          description: Is custom data record active in the ERP system.
          default: true
          type: boolean
        created_at:
          allOf:
          - $ref: '#/components/schemas/date-time'
        updated_at:
          allOf:
          - $ref: '#/components/schemas/date-time'
      required:
      - dataset_name
      - custom_external_id
    http-400-error-response:
      type: object
      properties:
        timestamp:
          type: string
          example: 2019-01-17T16:12:45.977+0000
        status:
          type: string
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: 'Error code : 17e3338d - Invalid request, please fix and resend'
    uuid-updated:
      type: object
      properties:
        uuid:
          type: string
          example: 5fc03087-d265-11e7-b8c6-83e29cd24f4c
        status:
          type: string
          example: UPDATED
    http-404-error-response:
      type: object
      properties:
        timestamp:
          type: string
          example: 2019-01-17T16:12:45.977+0000
        status:
          type: string
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: 'Error code : 17e3338d - The resource you specified cannot be not found'
  parameters:
    custom-external-id:
      in: path
      description: external-id for custom data item
      required: true
      name: custom-external-id
      schema:
        type: string
    custom-data-json-schema:
      in: body
      required: true
      name: custom-data-json-schema
      schema:
        $ref: '#/components/schemas/custom-data'
    uuid:
      in: path
      description: Globally unique identifier for an uploaded document
      required: true
      name: uuid
      schema:
        type: string
    dataset-name:
      in: path
      description: data set name
      required: true
      name: dataset-name
      schema:
        type: string
  securitySchemes:
    API_Key_Header:
      type: apiKey
      in: header
      name: x-api-key
    Customer_Id_Header:
      type: apiKey
      in: header
      name: customer-id
    Customer_Key_Header:
      type: apiKey
      in: header
      name: customer-key