Skip to content
Listener.comDevelopers

Meta

API root, the OpenAPI document and the calling credential's workspace.

API root

GET/v1
No auth

Version, links and the docs URL. No authentication.

Returns

200

OK

  • objectany
  • versionstring
  • docs_urlstring
  • openapi_urlstring
  • linksobject

Errors

400parameter_invalid404resource_not_found429rate_limited500internal_error

OpenAPI document

GET/v1/openapi.json
No auth

This API as an OpenAPI 3.1 document. No authentication.

Returns

200

OK

An OpenAPI 3.1 document.

Errors

400parameter_invalid404resource_not_found429rate_limited500internal_error

Retrieve the workspace and credential

GET/v1/me
shows:read

The workspace this credential resolves to: identity, kind (network, subnetwork or solo), plan, every show (id, name, handle, public URL, categories, connected platforms), missing_show_ids (shows the workspace points at that no longer exist; excluded everywhere), team and subnetwork counts, integrations summary and per-platform data freshness, plus the calling credential (type, id, label, scopes, OAuth client).

Start here: the show ids every other endpoint accepts come from this response or GET /v1/shows. Solo workspaces return one show; subnetworks report parent_network_uid.

SDKlistener.me.retrieve()client.me.retrieve()

Returns

200

OK

  • effective_uidstringrequired
  • authenticated_uidstringrequired
  • auth_kindstringrequired
  • scopesarray of stringsrequired
  • kindstringrequired
    One ofnetworksubnetworksolo
  • is_networkbooleanrequired
  • is_subnetworkbooleanrequired
  • network_namestringrequired
  • planstringrequired
  • showsarray of objectsrequired
    Show child attributesHide child attributes
  • show_countintegerrequired
  • team_sizeintegerrequired
  • subnetwork_countintegerrequired
  • app_urlstringrequired
  • computed_atstringrequired
  • cache_age_secondsnumberrequired
  • objectstringrequired
  • key_labelstringnullable
  • parent_network_uidstringnullable
  • network_handlestringnullable
  • network_logostringnullable
  • missing_show_idsarray of strings
    managedKits entries with no users/ doc; excluded from shows.
  • campaign_countintegernullable
  • integrations_summarymap of integer
    platform → number of shows with that platform connected or holding data.
  • data_freshnessmap of object
    platform → oldest freshness across shows.
    Show child attributesHide child attributes
  • stale_platformsarray of strings
  • network_default_emvobjectnullable
  • public_urlstringnullable
  • notestringnullable
  • credentialobject
    Show child attributesHide child attributes

Errors

400parameter_invalid401credential_invalid403scope_missing404resource_not_found429rate_limited500internal_error