AMCS Group Subscriber API
The Subscriber API from AMCS Group — 2 operation(s) for subscriber.
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/amcs-group:amcs-group-subscriber-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: '# Getting Started
## Document Purpose and Scope
The Scale REST API endpoints are technically described in this document. This document''s goal is to instruct readers on how to interface with the Scale REST API.
## Security
The API uses HTTPS as transport layer for security and uses HTTP/1.1 – RFC 7230 for message syntax and routing.
There are 2 ways of authenticating in order to access the REST API.
· Requesting a bearer token from /authTokens using username and password
· Requesting a session log on from /authTokens using a PAT token
Authentication using username and password will be phased out after 8.6.
## GET /authTokens with username and password direct to the App server
Before using this method a user must be set up with access right “Can POST, PUT, GET to the REST API”. This can be done from User Management in the Scale UI.
### Request format
The following table specifies the format and parameters for this request.
| Method | Type | Name | Type |
| --------- | --------- | ------------------ | ------------------ |
| GET | Parameter | Username | URI encoded string |
| Parameter | password | URI encoded string | |
### Response format
The following table specifies the format and parameters for the response.
| Successful response | Type | |
| ------------------- | --------- | ---- |
| Bearer token | text/html | |
The token returned is then uses as a Bearer token in the subsequent calls to the REST API
### Example
The following shows an example of a request to the authentication endpoint:
https://{scale-url}/scale/api/authTokens?username=john&password=password
The username and password in this request may need to be URI encoded.
The token in the response should be supplied in all subsequent requests in an authorization HTTP header.
Authorization: Bearer tcpRoNbIKOJZj9Yn0CL2oiX7m04JJmlAllaskd810incqjslasadjzxzza29axb
Notes:
· No specific Accept or Content-Type header is required for the authentication endpoint as it will always return text/html as content.
## POST /scale/api/authTokens with PAT token
Before using this method, a user must be set up with:
· Access right “Can POST, PUT, GET to the REST API”
· A PAT token
This can be done from User Management in the Scale UI.
### Request format
The following table specifies the format and parameters for this request.
| Method | Body |
| ------ | ------------------------------ |
| POST | { “privatekey”:”{PAT token}” } |
### Response format
The response passes a Platform.ERP.SessionToken as a cookie.
This cookie should be included in the subsequent calls to the REST API."'
title: Scale REST Subscriber API
version: '9.1'
servers:
- url: http://{env}-svc-core.amcsplatform.com/scale/api/
tags:
- name: Subscriber
paths:
/integrator/subscribers/{id}:
get:
tags:
- Subscriber
summary: Find with GUID
description: '| Property | Description |
| ----------------------------------------------------- | -------------------------------------------------------------- |
| Name | The name of the Subscriber |
| CompanyOutlets[] | The company outlets associated with the subscriber |
| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber |
| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description |
| CompanyOutlets[].SubscriberOutletListItem.AbbreviatedDescription | The company outlet abbreviated description |
| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid |
| RelatedSubscriberOutletGuid | The Related Subscriber Outlet Guid |
| GUID | The Subscriber Guid |'
operationId: Subscriber_Get
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: links
in: query
required: false
schema:
type: string
- name: include
in: query
required: false
schema:
type: string
- name: expand
in: query
required: false
schema:
type: string
- name: udf
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiSubscriberResource'
put:
tags:
- Subscriber
summary: Partial update
description: '| Property | Description | Required |
|-------------------------------------------------------|------------------------------------------------------------------------|----------|
| Name | The name of the Subscriber | No |
| CompanyOutlets[] | The company outlets associated with the subscriber | Yes |
| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber | Yes |
| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description | No |
| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid | Yes |
| RelatedSubscriberOutletGuid | The Related Subscriber Outlet Guid, required if it needs to be updated | No |
| GUID | The Subscriber Guid | No |'
operationId: Subscriber_Update
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
required: true
/integrator/subscribers:
get:
tags:
- Subscriber
summary: Find with Filters
description: '| Property | Description |
| ----------------------------------------------------- | -------------------------------------------------------------- |
| Name | The name of the Subscriber |
| CompanyOutlets[] | The company outlets associated with the subscriber |
| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber |
| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description |
| CompanyOutlets[].SubscriberOutletListItem.AbbreviatedDescription | The company outlet abbreviated description |
| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid |
| RelatedSubscriberOutletGuid | The Related Subscriber Outlet Guid |
| GUID | The Subscriber Guid |'
operationId: Subscriber_GetCollection
parameters:
- name: filter
in: query
required: false
schema:
type: string
- name: search
in: query
required: false
schema:
type: string
- name: order
in: query
required: false
schema:
type: string
- name: max
in: query
required: false
schema:
type: integer
format: int32
- name: page
in: query
required: false
schema:
type: integer
format: int32
- name: includeCount
in: query
required: false
schema:
type: boolean
- name: includeDeleted
in: query
required: false
schema:
type: boolean
- name: links
in: query
required: false
schema:
type: string
- name: udf
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiSubscriberResource'
post:
tags:
- Subscriber
summary: Create or update
description: '# Subscribers
| Property | Description | Required |
|-------------------------------------------------------|----------------------------------------------------------------|----------|
| Name | The name of the Subscriber | Yes |
| CompanyOutlets[] | The company outlets associated with the subscriber | Yes |
| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber | Yes |
| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description | No |
| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid | Yes |
| RelatedSubscriberOutletGuid | The Related Subscriber Outlet Guid | No |
| GUID | The Subscriber Guid | No |'
operationId: Subscriber_Create
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
required: true
components:
schemas:
ApiResourceResultCollectionExtra:
type: object
properties:
count:
format: int32
type: integer
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
associations:
type: array
items:
type: string
expand:
type: array
items:
type: string
operations:
type: array
items:
type: string
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceId:
type: object
properties:
resource:
format: int32
type: integer
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
AbbreviatedDescription:
type: string
Guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultCollection_ApiSubscriberResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiSubscriberResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceStatus:
type: object
properties:
id:
format: int32
type: integer
isSuccess:
type: boolean
ApiSubscriberCompanyOutletResource:
type: object
properties:
SubscriberOutletListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
RelatedSubscriberOutletGuid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ApiSubscriberResource:
type: object
properties:
Name:
type: string
CompanyOutlets:
type: array
items:
$ref: '#/components/schemas/ApiSubscriberCompanyOutletResource'
GUID:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiResourceResultEntity_ApiSubscriberResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiSubscriberResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'