List partners

GET

/api/integration/v1/partners

Returns the partners of this organization, newest change last.

The example applies to the demo environment only.

Request

curl -i -X GET "https://sandbox.api.earhiva.mk/api/integration/v1/partners" \
  -H "X-Api-Key: <YOUR KEY>" \
  -H "X-Software-Id: <NAME AND VERSION OF YOUR APPLICATION>"

Every call carries X-Api-Key with a key that has the IntegrationApi scope, and X-Software-Id with the name and version of your software. How to request a key is on Authentication.

Parameters

All parameters (4)

Parameter	In	Type	Presence	Description
changedSince	query	string	optional	Optional. Returns only partners changed at or after this moment, so a repeated call with the highest changedAt you received brings back only what moved since. ISO 8601.
page	query	integer · int32	optional	Page number, 1-based. Defaults to 1.
pageSize	query	integer · int32	optional	Page size. Defaults to 100, maximum 500.
X-Software-Id	header	string	always	Identifier of the calling software, e.g. SSBFocus/4.2.1. Free text, recorded in the audit trail. Required on every call; missing means EARH-1008.

Error codes

EARH-1001 · EARH-1002 · EARH-1003 · EARH-1004 · EARH-1005 · EARH-1006 · EARH-1010 · EARH-1011 · EARH-2020 · EARH-3005

The full list of codes, what each means and what to do, is in the Error catalogue.

Responses

200

The requested page, with the total number of matching partners.

{
  "items": [
    {
      "edb": "",
      "name": "",
      "address": "",
      "city": "",
      "postalCode": "",
      "country": "",
      "email": "",
      "origin": "",
      "changedAt": "2026-08-26T23:24:17+02:00"
    }
  ],
  "totalCount": 0,
  "nextFrom": "2026-08-26T23:24:17+02:00"
}

All fields in the body (3)

Field	Type	Presence	Description
items	array of object	always	Items on the requested page.
totalCount	integer · int32	always	Number of items matching the filter across all pages.
nextFrom	string · date-time	nullable	CR-0080 — starting point for the next incremental call. Non-null only when the caller asked for by=updated; with by=created incremental pulling is not promised, so it stays null.

400

EARH-2020 — changedSince, page or pageSize cannot be read. EARH-3005 — the requested page size exceeds the maximum.

{
  "type": "https://earhiva.mk/errors/EARH-2020",
  "title": "A parameter cannot be read as submitted.",
  "status": 400,
  "code": "EARH-2020"
}

All fields in the body (6)

Field	Type	Presence	Description
type	string	always	Address of this code in the error catalogue (RFC 7807).
title	string	always	Short, stable English summary of the error — the same string that appears in your log.
status	integer · int32	always	HTTP status code, repeated in the body (RFC 7807).
detail	string	nullable	What went wrong in this particular call, when there is more to say than the title. Absent when the title already says everything.
code	string	always	The EARH-xxxx code. This is the contract: match on it, not on the text.
eventId	string	nullable	Only on EARH-9000. Quote it when reporting the problem — it is the same reference we record in our log, so one number identifies the event on both sides.

401

The API key is missing, unknown, expired or revoked — EARH-1001, EARH-1002, EARH-1003. The body is the standard error body — the same on every call. What to do about each code is in the Error catalogue.

403

The caller’s address is outside the allowed list, the key does not carry the IntegrationApi scope, the organization’s plan does not include integration access, or the key has been switched off by its owner — EARH-1004, EARH-1005, EARH-1010, EARH-1011. The last two are returned on every call and carry no Retry-After: waiting does not change the state. The body is the standard error body — the same on every call. What to do about each code is in the Error catalogue.

429

The traffic limit for this key has been reached — EARH-1006. The response carries Retry-After. The limit is counted per key, and its size comes from the organization’s plan. The body is the standard error body — the same on every call. What to do about each code is in the Error catalogue.

500

Unexpected error on our side — EARH-9000. The body carries eventId; quote it when reporting the problem. The body is the standard error body — the same on every call. What to do about each code is in the Error catalogue.