Favicon

You are here: Home > App Distribution > API > Publications > GET - List of Publications

GET - List of Publications

Learn how to list your Applivery application publications using the Integrations API and Workspace API. Retrieve publication IDs and more.

5 min read

TL;DR

Learn how to list Applivery application publications using the Integrations API (per-app) or Workspace API (workspace-level) to retrieve publication details.

Return a paginated list of publications for a given app. Use this endpoint to query the current state of your publications, retrieve publishedApplicationId values needed by other endpoints, or build dashboards and automation scripts that act on specific publications.

Applivery provides two separate APIs for listing publications, 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 and storeId required in the path
Typical users Scripts that look up a publication's ID before updating it Platform engineers querying 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 listing publications 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

Authentication

Authorization: Bearer <your_app_token>

Query parameters

All parameters are optional. When no filters are applied, the endpoint returns all publications for the app associated with the token.

Parameter Type Description
slug String Filter by publication slug. Returns only the publication matching this exact slug.
security String Filter by security mode. Allowed values: public, password, logged.
visibility String Filter by visibility state. Allowed values: active, inactive, unlisted.
filter-type String Filter by build selection strategy. Allowed values: last, build, builds, gitBranch, gitTag, tag.
page Integer Page number for pagination. Starts at 1.
limit Integer Maximum number of publications to return per page.

Example Request

curl 'https://api.applivery.io/v1/integrations/distributions?visibility=active&security=public' \
  -X GET \
  -H 'Authorization: Bearer YOUR_APP_TOKEN'

Responses

{
  "status": true,
  "data": {
    "items": [
      {
        "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": []
      }
    ],
    "totalDocs": 0,
    "limit": 0,
    "hasPrevPage": true,
    "hasNextPage": true,
    "page": 0,
    "totalPages": 0,
    "pagingCounter": 0,
    "prevPage": 0,
    "nextPage": 0
  }
}

{
  "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 the publication (publishedApplicationId). Use this value in PUT – Update and DELETE endpoints.
slug The URL-friendly identifier used to construct the publication URL.
distributionUrl The full public URL of the publication. Share this with users to give them access.
security Current security mode: public, password, or logged.
visibility Current visibility state: active, inactive, or unlisted.
filter.type Build selection strategy currently configured: last, build, builds, gitBranch, gitTag, or tag.
expirationDate ISO 8601 timestamp after which the publication becomes unavailable. null if no expiration is set.
activateUserAudiences Whether audience-based access control is enabled for this publication.
userAudienceMap Array of audience assignments for this publication.
allowedCountries Country codes from which access is explicitly allowed. Empty array means no restriction.
blockedCountries Country codes from which access is explicitly blocked. Empty array means no restriction.
configuration Branding and app name/description overrides applied to this publication.
terms Legal terms configuration — whether acceptance is required and the terms text.

Pagination fields

Field Description
totalDocs Total number of publications matching the query.
page Current page number.
totalPages Total number of pages.
limit Number of results per page.
hasNextPage Whether there is a subsequent page of results.
hasPrevPage Whether there is a previous page of results.
nextPage Page number of the next page, or null if on the last page.
prevPage Page number of the previous page, or null if on the first page.

Workspace API

Use this endpoint when listing publications 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

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) whose publications you want to list.

Authentication

Authorization: Bearer <your_service_account_token>

Query parameters

The Workspace API accepts the same query parameters as the Integrations API.

Example Request

curl 'https://api.applivery.io/v1/organizations/ORG_ID/stores/STORE_ID/pubApps?visibility=active' \
  -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 listing publications: Integrations API and Workspace API.
  • The Integrations API uses an App API Token, while the Workspace API uses a Service Account token.
  • Both APIs return a paginated list of publications with various details.
  • Use the `publishedApplicationId` to update or remove publications.
  • The Workspace API requires `organizationId` and `storeId` in the path.