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

Repsly Clients API

Export and import clients and client notes.

Repsly Clients API is one of 9 APIs that Repsly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 3.0.

Requests are made against a single base URL, https://api.repsly.com/v3.

3 operations 3 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0
Base URL
https://api.repsly.com/v3
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Repsly Clients 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 over SSL. Use the API username and password from the Repsly settings page (API Settings) - these differ from your Repsly login creden…

Paths & Operations 3

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

Clients 3

Export and import clients and client notes.

GET
/export/clients/{lastTimestamp}
Export clients
exportClients 1 param → 200401
GET
/export/clientnotes/{lastClientNoteID}
Export client notes
exportClientNotes 1 param → 200401
POST
/import/client
Import clients
importClients body → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Client (9 properties), MetaCollectionResult (4 properties), ImportResult (2 properties), ClientCollection (2 properties). Each schema is shown below with its type and property counts.

GenericCollection
object
Generic export collection envelope. Each export endpoint returns an entity array plus MetaCollectionResult; entity fields are documented per resource in the Re…
2 properties
Error
object
2 properties
ClientCollection
object
2 properties
Client
object
A Repsly client (retail location / account). Fields modeled from the v3 reference; confirm exact names against the live documentation.
9 properties
ImportResult
object
Result of an import (POST) call, including the job identifier.
2 properties
MetaCollectionResult
object
Pagination metadata returned with export collections. Iterate until TotalCount is 0.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

repsly-clients-api-openapi.yml Raw ↑

Other APIs Repsly publishes across the network.

Repsly Forms API
Repsly Import API
Repsly Photos API
Repsly Pricelists API
Repsly Products API
Repsly Purchase Orders API
Repsly Representatives API
Repsly Visits API