Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CSG Systems Customers API

Customer record management

CSG Systems Customers API is one of 7 APIs that CSG Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, a support channel, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against 2 base URLs: https://api.forte.net/v3, https://sandbox.forte.net/api/v3.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.forte.net/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

CSG Systems Customers API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using API access ID as username and API secure key as password. Include organization ID and location ID in the X-Forte-Auth-Organizat…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 5

Customer record management

GET
/organizations/{organizationId}/locations/{locationId}/customers
List customers
listCustomers 7 params → 200
POST
/organizations/{organizationId}/locations/{locationId}/customers
Create a customer record
createCustomer 2 params body → 201
GET
/organizations/{organizationId}/locations/{locationId}/customers/{customerId}
Get customer details
getCustomer 3 params → 200404
PUT
/organizations/{organizationId}/locations/{locationId}/customers/{customerId}
Update a customer record
updateCustomer 3 params body → 200
DELETE
/organizations/{organizationId}/locations/{locationId}/customers/{customerId}
Delete a customer record
deleteCustomer 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Address (8 properties), CustomerRequest (6 properties), CustomerSummary (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Customer
Address
object
8 properties
CustomerRequest
object
6 properties
CustomerList
object
2 properties
Error
object
3 properties
CustomerSummary
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

csg-customers-api-openapi.yml Raw ↑

Other APIs CSG Systems publishes across the network.

CSG Forte.js
CSG Forte React Native SDK
CSG Singleview Billing API
CSG Systems Payment Methods API
CSG Systems Settlements API
CSG Systems Transactions API