Erply External IDs API
The External IDs API from Erply — 4 operation(s) for external ids.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/erply-external-ids-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
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 External IDs API
contact: {}
version: 2.36.5
tags:
- name: External IDs
paths:
/v1/external-ids:
get:
security:
- sk: []
- cc: []
- jwt: []
description: 'Currently supported entities: category'
tags:
- External IDs
summary: Read external IDs
parameters:
- description: up to 100 external IDs
name: externalIds
in: query
schema:
type: array
items:
type: string
- description: up to 100 object IDs
name: objIds
in: query
schema:
type: array
items:
type: string
- description: 'Entity name to filter by (currently supported: category)'
name: entityName
in: query
required: true
schema:
type: string
- description: integration name
name: integrationName
in: query
required: true
schema:
type: string
- description: skip n records
name: skip
in: query
schema:
type: integer
- description: 'items to take, default: 20, max: 100000'
name: take
in: query
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/models.ExternalIDResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
/v1/external-ids/{entityName}/{objIds}:
delete:
security:
- sk: []
- cc: []
- jwt: []
description: 'Currently supported entities: category'
tags:
- External IDs
summary: Delete external IDs of entities
parameters:
- description: Specify the integration name to delete the external ID associated with the integration only.
name: integrationName
in: query
required: true
schema:
type: string
- description: 'Entity name (currently supported: category)'
name: entityName
in: path
required: true
schema:
type: string
- description: up to 100 semicolon delimited ids
name: objIds
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
/v1/external-ids/{entityName}/{objId}:
patch:
security:
- sk: []
- cc: []
- jwt: []
description: 'Currently supported entities: category'
tags:
- External IDs
summary: Update external ID of an entity
parameters:
- description: 'Entity name (currently supported: category)'
name: entityName
in: path
required: true
schema:
type: string
- description: Object ID
name: objId
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/models.ExternalIDPatchRequest'
description: request
required: true
/v1/external-ids/{objId}:
post:
security:
- sk: []
- cc: []
- jwt: []
description: 'Currently supported entities: category'
tags:
- External IDs
summary: Attach external ID to an entity
parameters:
- description: Object ID
name: objId
in: path
required: true
schema:
type: integer
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/responses.Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/responses.MessageResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/models.ExternalIDPatchRequest'
description: request
required: true
components:
schemas:
responses.Response:
type: object
properties:
id:
type: integer
example: 73
models.ExternalIDPatchRequest:
type: object
properties:
external_id:
type: string
integration_name:
type: string
models.ExternalIDResponse:
type: object
properties:
added:
description: Unix timestamp
type: integer
example: 1595230999
addedby_id:
description: user ID
type: integer
example: 1
changed:
description: Unix timestamp
type: integer
example: 1595230999
changedby_id:
description: user ID
type: integer
example: 1
entityName:
type: string
external_id:
type: string
integration_name:
type: string
obj_id:
type: integer
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
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