Favicon

You are here: Home > App Distribution > API > Publications > GET - Publication Details

GET - Publication Details

Learn how to retrieve publication details using Applivery's Integrations and Workspace APIs. Includes endpoints, authentication, and examples.

5 min read

TL;DR

Learn how to retrieve publication details from Applivery using either the Integrations API (App API Token) or the Workspace API (Service Account token).

Return the full configuration of a single publication, identified by its publishedApplicationId. Use this endpoint to inspect the current state of a specific publication before updating it, verify its access settings, or retrieve its distributionUrl.

Warning

Before updating a publication with PUT**, always retrieve its current details with this endpoint first. The PUT endpoint is a full replacement — fetching the current state lets you preserve fields you don't intend to change.

Applivery provides two separate APIs for retrieving publication details, each requiring a different authentication credential.

Choosing the right API

Integrations API Workspace API
Designed for Per-app integrations and CI/CD pipelines Workspace-level automation across multiple apps
Authentication App API Token (per-app) Service Account token (workspace-level)
App context Implicit — token is already scoped to an app Explicit — organizationId, storeId, and publishedApplicationId required in the path
Typical users Scripts that read a publication's config before updating it Platform engineers inspecting publications across multiple apps
Warning

Access to the different APIs might not be available in your current plan. Please check availability on our pricing page.

Integrations API

Use this endpoint when retrieving publication details within the scope of a single app. Authentication uses an App API Token, scoped to the specific app.

To create an App API Token, see Apps API Authentication.

Endpoint

GET https://api.applivery.io/v1/integrations/distributions/{publishedApplicationId}

Authentication

Authorization: Bearer <your_app_token>

Path parameters

Parameter Type Required Description
publishedApplicationId String Yes The unique identifier of the publication to retrieve. E.g. 552ae3cfcb5abfc58d733b81. Returned by POST – Create a Published Application and GET – List of Published Applications.

Example Request

curl 'https://api.applivery.io/v1/integrations/distributions/552ae3cfcb5abfc58d733b81' \
  -X GET \
  -H 'Authorization: Bearer YOUR_APP_TOKEN'

Responses

{
  "status": true,
  "data": {
    "id": "string",
    "updatedAt": "2025-10-23T07:54:26.518Z",
    "createdAt": "2024-07-23T08:10:46.471Z",
    "application": "string",
    "applicationInfo": {
      "id": "string",
      "slug": "string",
      "name": "string",
      "picture": "string"
    },
    "slug": "string",
    "filter": {
      "type": "last",
      "value": "string",
      "ios": "string",
      "android": "string",
      "windows": "string",
      "macos": "string",
      "builds": [
        {
          "buildPlatform": "string",
          "id": "string"
        }
      ]
    },
    "security": "public",
    "tags": ["string"],
    "groups": [["string"]],
    "activateUserAudiences": false,
    "userAudienceMap": [],
    "visibility": "active",
    "showHistory": false,
    "showDevInfo": false,
    "expirationDate": "string",
    "distributionUrl": "string",
    "terms": {
      "active": true,
      "text": "string"
    },
    "configuration": {
      "branding": {
        "logo": "string",
        "primaryColor": "string",
        "useAppIcon": false
      },
      "application": {
        "description": "string",
        "name": "string"
      }
    },
    "allowedCountries": [],
    "blockedCountries": []
  }
}

{
  "status": false,
  "error": {
    "code": 4002,
    "message": "No auth token"
  }
}

{
  "status": false,
  "error": {
    "code": 3001,
    "message": "Entity not found"
  }
}

Key response fields

Field Description
id The unique identifier of this publication (publishedApplicationId).
slug The URL-friendly identifier used to construct the publication URL.
distributionUrl The full public URL of the publication.
security Current security mode: public, password, or logged.
visibility Current visibility state: active, inactive, or unlisted.
filter.type Build selection strategy: last, build, builds, gitBranch, gitTag, or tag.
filter.value The branch name, git tag, or build tag currently configured (for gitBranch, gitTag, and tag filter types).
filter.ios / filter.android / filter.macos / filter.windows Build IDs per platform (for build filter type).
filter.builds Array of { buildPlatform, id } objects (for builds filter type, including custom platforms).
expirationDate ISO 8601 timestamp after which the publication becomes unavailable. null if no expiration is configured.
groups Nested array of user group identifiers controlling access (AND/OR logic).
activateUserAudiences Whether audience-based access control is enabled.
userAudienceMap Array of audience assignments, each with id and notifyNewBuildsProcessed.
showHistory Whether users can browse and install previous builds.
showDevInfo Whether technical build information (git metadata, certificate details, tags) is shown to users.
allowedCountries Country codes from which access is explicitly allowed. Empty array means no country restriction.
blockedCountries Country codes from which access is explicitly blocked. Empty array means no country restriction.
configuration.application App name and description overrides applied to this publication.
configuration.branding Logo, primary color, and button color overrides applied to this publication.
terms Legal terms configuration — active indicates whether acceptance is required, text contains the terms content.

Workspace API

Use this endpoint when retrieving publication details at the workspace level — for example, in automation pipelines that operate across multiple apps using a single credential.

Authentication uses a Service Account token, which is workspace-scoped and not tied to any individual app.

To create a Service Account, see Service Accounts.

Endpoint

GET https://api.applivery.io/v1/organizations/{organizationId}/stores/{storeId}/pubApps/{publishedApplicationId}

Path parameters

Parameter Type Required Description
organizationId String Yes The unique identifier of your Applivery organization.
storeId String Yes The unique identifier of the store (app project) the publication belongs to.
publishedApplicationId String Yes The unique identifier of the publication to retrieve.

Authentication

Authorization: Bearer <your_service_account_token>

Example Request

curl 'https://api.applivery.io/v1/organizations/ORG_ID/stores/STORE_ID/pubApps/552ae3cfcb5abfc58d733b81' \
  -X GET \
  -H 'Authorization: Bearer YOUR_SERVICE_ACCOUNT_TOKEN'

The response schema is identical to the Integrations API.

Key Takeaways

  • Applivery provides two APIs for retrieving publication details: Integrations API and Workspace API.
  • Integrations API uses App API Token for authentication, while Workspace API uses Service Account token.
  • The response schema is identical for both APIs.
  • Always retrieve the current publication details before updating them.
  • The `distributionUrl` field provides the public URL of the publication.