Erply auth API

The auth API from Erply — 1 operation(s) for auth.

Operations 1

POST /api/v1/auth Authenticate to get session token

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-auth-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-auth-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 Auth API
  contact: {}
  version: 2.36.5
tags:
- name: auth
paths:
  /api/v1/auth:
    post:
      description: Returns an Erply session token which can be used for calling the authenticated endpoints. This session token is retrieved from Erply API and the authentication method is exposed here just for the convenience. During actual use the client system does not need to authenticate against this endpoint, but can retrieve the Erply session token by any means available to them
      tags:
      - auth
      summary: Authenticate to get session token
      deprecated: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIAuthResponse'
        '400':
          description: Problematic request
        '401':
          description: Forbidden
        '500':
          description: Internal Server Error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIAuthRequest'
        description: Authenticate
        required: true
components:
  schemas:
    APIAuthRequest:
      type: object
      properties:
        clientCode:
          type: string
          example: '123456'
        password:
          type: string
          example: secret
        setCookie:
          type: boolean
          example: true
        username:
          type: string
          example: username
    APIAuthResponse:
      type: object
      properties:
        employeeID:
          type: string
          example: '1'
        employeeName:
          type: string
          example: Bob Smith
        sessionExpiration:
          type: integer
          example: 1661856635
        sessionKey:
          type: string
          example: d5884b1cc10b5b2f3a9601f27a21c3b57925a79fd75d
        setCookie:
          type: boolean
          example: false
        token:
          type: string
          example: jwt.token
        userID:
          type: string
          example: '1'
        userName:
          type: string
          example: username
  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