Access Points

Get a filtered access point roster breakdown

The five roster breakdowns of GET /v1/aps/{key} (country, entity type, NACE Rev. 2.1 division, size class, region) recomputed over a FILTERED slice of the roster, so a breakdown stays true while the roster is cut down. The filters are the same names and shapes as GET /v1/participants, scoped to this provider's seats.

BOUNDED BY DESIGN. The breakdowns are computed only when the filtered slice is narrow (under an internal cap of 10,000 participants). A request that narrows on nothing, that carries a filter this endpoint cannot express (doctype, transport_profile, q, host, sub_provider, postcode, provenance, vat_liable), or whose slice is too wide answers degraded: true with every mix null — never a wrong number and never an error. Callers fall back to the stored whole-roster mixes on GET /v1/aps/{key}.

Counts are sparse the same way the stored mixes are: company enrichment covers a handful of registers, so every mix except country_mix sums BELOW participant_count and the un-enriched remainder is derived from the total rather than served as a bucket.

A Vendor key (v-<slug>) answers the same question over the Vendor's roster and needs a Market-tier key. seat then selects one Seat the Vendor connects through.

get/v1/aps/{key}/roster-mix

Request

  • Base URL: https://api.peppolstatus.com
  • URL: https://api.peppolstatus.com/v1/aps/{key}/roster-mix
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

keystring required

The provider key (e.g. c-tickstar, o-teamleader-nv-1f3a2b9c), or a Vendor key (v-exact).

Query parameters

seatstring

Scope the slice to ONE member seat of this provider. A seat that is not a member answers an empty (not degraded) slice. Single-valued.

countrystring[]

Comma-array of ISO-3166-1 alpha-2 country codes. Matched on the participant's card country, falling back to the country its ICD prefix implies — the same rule the stored country_mix buckets on.

entity_typestring[]

Comma-array of company legal-form families (company, natural_person, association, public).

sectorstring[]

Comma-array of 2-digit NACE Rev. 2.1 divisions (47,62).

sizestring[]

Comma-array of company size classes (as stored).

regionstring[]

Comma-array of company seat region codes (NO-32,BE-BRU).

not_countrystring[]

Comma-array of country codes (NO,SE) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: ?region=NO-03&not_region=NO-32 applies both.

not_entity_typestring[]

Comma-array of company legal-form families (company,natural_person,association,public) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: ?region=NO-03&not_region=NO-32 applies both.

not_sectorstring[]

Comma-array of 2-digit NACE Rev. 2.1 divisions (47,62) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: ?region=NO-03&not_region=NO-32 applies both.

not_sizestring[]

Comma-array of company size band codes (as stored: 21,NN; FR and NO only) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: ?region=NO-03&not_region=NO-32 applies both.

not_regionstring[]

Comma-array of company seat region codes (NO-32,BE-BRU) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: ?region=NO-03&not_region=NO-32 applies both.

schemestring[]

Comma-array of Peppol identifier schemes.

smpstring[]

Comma-array of SMP hostnames serving the participant.

registeredboolean

Restrict to participants present (true) or absent (false) in the Peppol Directory.

Response

The filtered roster breakdowns, or a degraded answer when they cannot be computed honestly.

keystring required

The canonical provider key (see ApView.key). Always the current one.

degradedboolean required

True when the breakdowns could not be computed honestly — the request narrowed on nothing, carried a filter this endpoint cannot express, or selected a slice wider than the internal cap. Every mix and the count are then null and the caller falls back to the stored whole-roster mixes on GET /v1/aps/{key}.

participant_countinteger nullable required

Exact size of the filtered slice (not an estimate, not capped). Null when degraded.

Changes

No recorded changes to this operation across all 1 revision of this API.