Erply v3 API

The v3 API from Erply — 2 operation(s) for v3.

Operations 4

PUT /v3/configuration Save or update a configuration
GET /v3/configuration/{id} Get by ID
PUT /v3/configuration/{id} Update `value` by ID
DELETE /v3/configuration/{id} Delete By ID

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/erply-v3-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

erply-v3-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
  title: assignments Assortment V3 API
  contact: {}
  version: 2.36.5
tags:
- name: v3
paths:
  /v3/configuration:
    put:
      security:
      - sk: []
      - cc: []
      - hmac-auth: []
      - jwt: []
      description: '`NB`: You cannot have 2 configurations with the same level,level_id, type, name and application

        level, level_id and type are optional fields.'
      tags:
      - v3
      summary: Save or update a configuration
      parameters:
      - description: UNIX timestamp used for the HMAC Auth method only
        name: timestamp
        in: header
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configurationRequest'
        description: ConfigurationDbRecord
        required: true
  /v3/configuration/{id}:
    get:
      security:
      - sk: []
      - cc: []
      - hmac-auth: []
      - jwt: []
      tags:
      - v3
      summary: Get by ID
      parameters:
      - description: UNIX timestamp used for the HMAC Auth method only
        name: timestamp
        in: header
        schema:
          type: string
      - description: Configuration ID
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/configuration'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
    put:
      security:
      - sk: []
      - cc: []
      - hmac-auth: []
      - jwt: []
      description: Update `value` by ID
      tags:
      - v3
      summary: Update `value` by ID
      parameters:
      - description: UNIX timestamp used for the HMAC Auth method only
        name: timestamp
        in: header
        schema:
          type: string
      - description: Configuration ID
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/valueRequest'
        description: new configuration value
        required: true
    delete:
      security:
      - sk: []
      - cc: []
      - hmac-auth: []
      - jwt: []
      description: Delete By ID
      tags:
      - v3
      summary: Delete By ID
      parameters:
      - description: UNIX timestamp used for the HMAC Auth method only
        name: timestamp
        in: header
        schema:
          type: string
      - description: configuration ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
components:
  schemas:
    configurationRequest:
      type: object
      properties:
        application:
          description: Application (s) name that uses CAFA to store configs, application name has to be generated manually before it can be used in Identity Admin.
          type: string
          example: woo-comm
        level:
          description: Level is the operating level where the config will be stored. Has to be one of Company, Warehouse, Pos, User
          type: string
          example: Pos
        level_id:
          description: 'LevelID is a unique value, used to identify the instance of the level.

            for User level, user id

            for Pos - Point of Sale ID. Each Pos belongs to Warehouse. When we query CAFA for configuration on level: ''Pos'', and add ''Look-Deeper: true'' header, if CAFA dooes not find any configuration with the query parameters, CAFA will use the level_id(PointOfSaleID), to find which Warehouse the Pos belongs to and check for configuration with the same name(and type if present)

            Warehouse can use any unique string to identify the instance of its level, because the higher level for each Warehouse is Company level, which can only be one instance per account

            Company level does not need level_id because there can only be one company per account in Erply.'
          type: string
          example: '1'
        name:
          description: Name of the configuration
          type: string
          example: adyen
        type:
          description: 'Type is an optional grouping property, in this case its ''payment'',

            indicating that this configuration belongs to payment integrations group

            used to query groups of related configurations'
          type: string
          example: payment
        value:
          description: 'Value stored by the configuration. Supported types: JSON, JSON array, string'
    valueRequest:
      type: object
      properties:
        value:
          description: 'Value stored by the configuration. Supported types: JSON, JSON array, string'
    response:
      type: object
      properties:
        id:
          type: integer
        message:
          type: string
        statusCode:
          type: string
    configuration:
      type: object
      properties:
        added:
          type: integer
        addedby_id:
          type: integer
        application:
          type: string
          example: erply-to-woo-sync
        changed:
          type: integer
        changedby_id:
          type: integer
        id:
          type: string
        level:
          description: Level is optional
          type: string
          example: Pos
        level_id:
          description: LevelID is optional
          type: string
          example: '1'
        name:
          type: string
          example: adyen
        type:
          description: Type is optional
          type: string
          example: payment
        value: {}
  securitySchemes:
    AccessToken:
      type: apiKey
      name: accessToken
      in: header
    ErplyClientCode:
      type: apiKey
      name: clientCode
      in: header
    ErplyJWT:
      type: apiKey
      name: jwt
      in: header
    ErplySession:
      type: apiKey
      name: sessionKey
      in: header
    RequestKey:
      type: apiKey
      name: requestKey
      in: header