---
title: "Contentstack Delivery Android SDK"
description: "Documentation for Android Delivery SDK"
url: "https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/android/reference"
product: "Contentstack"
doc_type: "guide"
audience:
  - developers
  - admins
version: "current"
last_updated: "2025-09-15"
---

# Contentstack Delivery Android SDK

## Contentstack - Android Delivery SDK

## Android Delivery SDK for Contentstack

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application front end, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/docs/developers/java/).

Contentstack provides Android Delivery SDK to build applications on top of Android. Given below is the detailed guide and helpful resources to get started with our Android Delivery SDK.

## Prerequisite

To get started with Android SDK, you will the following:

*   Android Studio IDE
*   Android API SDK support 19 and above
*   Java SDK version 1.8 or later

## SDK Installation and Setup

Using Android Studio, you can easily add dependencies by opening the app's **build.gradle** file, under the dependencies section in the project:

dependencies{  
    implementation 'com.contentstack.sdk:android:{version}'  
}

You can download the latest dependency version [here](https://mvnrepository.com/artifact/com.contentstack.sdk/android)

## Quickstart in 5 mins

## Initializing your SDK

**For setting the Region refer to the code below:**

import com.contentstack.sdk.\*;
Config config = Config();
config.region = ContentstackRegion.EU;
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

**For setting the Branch refer to the code below:**

import com.contentstack.sdk.\*;

Config config = Config();
config.setBranch("branch");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

**Note:** Use the following region codes based on your platform and location:

*   **NA** for North America
*   **EU** for Europe
*   **AU** for Australia
*   **AZURE NA** for Azure North America
*   **AZURE EU** for Azure Europe
*   **GCP NA** for GCP North America
*   **GCP EU** for GCP Europe

## Basic Queries

Contentstack SDKs let you interact with the [Content Delivery APIs](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) and retrieve content from Contentstack. They are read-only in nature. The SDKs fetch and deliver content from the nearest server via Fastly, our powerful and robust CDN.

**Get a Single Entry**

To retrieve a single entry from a [content type](https://www.contentstack.com/docs/developers/create-content-types/about-content-types/), use the code snippet given below:

import com.contentstack.sdk.\*;  
  
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");  
ContentType contentType = stack.contentType("contentTypeUid");  
Entry entry = contentType.entry("entryUid");  
entry.fetch(new EntryResultCallBack(){	  
@Override public void onCompletion(ResponseType responseType, Error error) {  
   if (error == null) {  
    System.out.println("response: "+entry.title);  
 }}  
});

  

**Get Multiple Entries**

To retrieve multiple entries of a particular content type, use the code snippet given below:

import com.contentstack.sdk.\*;  
  
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");  
Query query = stack.contentType("contentTypeUid").query();  
query.find(new QueryResultsCallBack(){  
@Override public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){         
  if(error == null) {   
     System.out.println("response: "+entry.title);  
  }  
}  
});

**Note:**

*   Currently, the Android SDK does not support multiple content types referencing in a single query. For more information on how to query entries and assets, refer to the [Queries](https://www.contentstack.com/docs/developers/apis/content-delivery-api/#queries) section of our Content Delivery API documentation
*   By default, the limit for response details per request is 100, with the maximum limit set at 250.

## Pagination

In a single instance, the [Get Multiple Entries](https://www.contentstack.com/docs/developers/java/get-started-with-java-delivery-sdk/#get-multiple-entries) query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the **skip** and **limit** parameters in subsequent requests.

import com.contentstack.sdk.\*;  
   
Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");   
Query query = stack.contentType("contentTypeUid").query();    
query.skip(20).limit(20).find(new QueryResultsCallBack(){    
  @Override  public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){   
   if(error == null){  
     System.out.println("response: "+queryResult);  
   }}    
});

## Contentstack

Contentstack class that exposes Stack instance

## stack

The stack method provides access to the stack of your site, allowing users to retrieve and manage content within a single space.

The application context

API Key of your application on Contentstack

Delivery Tokens retrieves only the published entries of the environment with which it is associated

A publishing environment refers to one or more deployment servers or a content delivery destination (Webpage’s address) where you will publish your content ([entries](https://www.contentstack.com/docs/content-managers/working-with-entries/about-entries/) or [assets](https://www.contentstack.com/docs/content-managers/working-with-assets/about-assets/)).

Config instance to set environment and other configuration details.

## Contentstack

## Config

Config class that exposes config instance, Where the user can provide other configurations on the stack

## setBranch

The setBranch method sets the target branch for the stack to retrieve content from a specific development or release branch.

branch you want to set

## getBranch

The getBranch method retrieves the branch currently set on the stack.

## setProxy

The setProxy method sets a custom proxy to route SDK network requests through a specified HTTP proxy server.

Proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object

## getProxy

Returns the Proxy instance

## getRegion

The getRegion method retrieves the region associated with the request URL.

## setRegion()

The setRegion method sets the database region for your stack. You can choose from seven regions: NA, AU, EU, Azure NA, Azure EU, GCP NA, and GCP EU.

You can choose from seven regions namely, NA, EU, AU, Azure NA, Azure EU, GCP NA, and GCP EU.

## getHost()

The getHost method retrieves the host associated with the request URL.

## setHost()

The setHost method sets a custom host for the request URL to direct API calls to a specified endpoint.

The host

## getVersion()

The getVersion method retrieves the version of the request path.

## setManagementToken()

The setManagementToken method adds the management token to the stack header to authorize content management operations.

The Management Token

## earlyAccess

The earlyAccess method retrieves features by enabling the early access header, allowing access to functionalities that are part of the early access program.

## Asset

In Contentstack, any files (images, videos, PDFs, audio files, and so on) that you upload get stored in your repository for future use. This repository of uploaded files is called Assets.

## fetch

The fetch method retrieves a particular asset by using its asset UID.

callback of the asset response

## includeBranch

Includes Branch in the asset response

## includeFallback

The includeFallback method includes the fallback language content in the asset response when the specified locale content is unavailable.

## includeMetadata

The includeMetadata method includes the asset metadata along with the response body.

## addParam

The addParam method adds a query parameter to the asset request to filter the response.

Key of the header you want to add

Add value to the header against the header key

## includeDimension

The includeDimension method includes the dimension information such as height and width in the asset response.

## setTags

The setTags method includes the specified tags in the asset response to categorize the asset.

## getTags

Includes Array of tags in the asset response

## getDeletedBy

Gets Deleted by object from the asset response

## getDeleteAt

Gets Deleted At object from the asset response

## getUpdatedBy

Gets UpdatedBy object from the asset response

## getUpdateAt

The getUpdateAt method retrieves the updated at object from the asset response, indicating the timestamp when the asset was last updated.

## getCreatedBy

The getCreatedBy method retrieves the created by object from the asset response, indicating which user created the asset.

## getCreateAt

The getCreateAt method retrieves the created at object from the asset response, indicating the timestamp when the asset was created.

## toJSON

The toJSON method retrieves the JSON object representation of the asset from the asset response.

## getUrl

The getUrl method retrieves the URL of the asset from the asset response.

## getFileName

The getFileName method retrieves the file name of the asset from the asset response.

## getFileSize

The getFileSize method retrieves the file size of the asset from the asset response.

## getFileType

The getFileType method retrieves the file type of the asset from the asset response.

## getAssetUid

The getAssetUid method retrieves the asset UID from the asset response.

## removeHeader

The removeHeader method removes a header from the request by using the specified key.

Key of the header you want to remove

## AssetLibrary

In Contentstack, any files (images, videos, PDFs, audio files, and so on) that you upload get stored in your repository for future use. This repository of uploaded files is called Assets.

## sort

The sort method sorts the asset library based on order criteria.

the key order by

the orderby can be applied using ORDERBY enums

## includeCount

The includeCount method includes the total count of assets in the asset library response.

## includeRelativeUrl

The includeRelativeUrl method includes the relative URLs of assets in the asset library response.

## includeMetadata

The includeMetadata method includes the asset library metadata along with the response body.

## setHeader

The setHeader method adds a header to the request using the specified key and value.

The key you want to remove from the header

Value of the header against the key

## removeHeader

The removeHeader method removes a header associated with the specified key.

The key you want to remove from the header

## includeFallback

The includeFallback method includes the fallback language content in the asset response when the specified locale content is unavailable.

## getCount

The getCount method returns the total number of assets available in the stack.

## setHeader

Fetch all the assets

The callback of type FetchAssetsCallback

## where

The where method retrieves assets from the stack by applying filter conditions on any field UID associated with the assets.

Enter the field UID of the asset

Enter the value

## ContentType

Content type defines the structure or schema of a page or a section of your web or mobile property. To create content for your application, you are required to first create a content type, and then create entries using the content type.

## removeHeader

The removeHeader method removes a header from the stack by using the specified header key.

The key of the header

## entry

The entry method retrieves a specific entry, which is an actual piece of content created using one of the defined content types.

The entry unique ID of the entry that you want to fetch

## query

The query method returns a query instance for building and executing advanced entry queries on a specified content type.

## fetch

The fetch method retrieves all the content types available for the stack.

key value parameters of type JSONObject

The callback of type ContentTypesCallback

## Entry

An entry is the actual piece of content created using one of the defined content types.

## exceptWithReferenceUid()

The exceptWithReferenceUid method specifies an array of except keys that gets excluded from the response.

Array of the except reference keys to be excluded in response

Key who has reference to some other class object

## onlyWithReferenceUid

The onlyWithReferenceUid method specifies an array of reference UIDs that should be included in the response.

Array of the only reference keys to be included in response.

Key who has reference to some other class object

## only

The only method specifies an array of keys in the base object to include in the response.

Array of the only reference keys to be included in response

## includeReference

The includeReference method adds a constraint that requires the details of a specified reference key.

referenceFields array key that to be constrained

## except

The except method specifies an array of field UIDs that are excluded from the response.

field uid which get excluded from the response.

## setLocale

The setLocale method sets the language of the entry.

language code

## getLocale

The `getLocale` method retrieves the locale of the entry, indicating the language of the content.

## getUid

The getUid method retrieves the UID of the entry.

## getContentType

The getContentType method retrieves the content type of the entry.

## getTags

The getTags method retrieves the tags associated with the entry.

## removeHeader

The removeHeader method removes a header associated with the specified key.

key of the header you want to remove

## setHeader

The setHeader method adds a header using the specified key and value.

key of the header you want to remove

value of the header against the key

## fetch

The fetch method retrieves the entry using its UID, and can optionally include query parameters to refine the response.

EntryResultCallBack object to notify the application when the request has completed

## addParam

The addParam method adds query parameters to the entry request to filter the response.

key of the header

value of the header

## includeReferenceContentTypeUID

The includeReferenceContentTypeUID method includes the content type UIDs of referenced entries in the entry response.

## includeContentType

The includeContentType method includes the content type UID of the entry.

## includeFallback

The includeFallback method includes the fallback language content in the entry response when the specified locale content is unavailable.

## includeEmbeddedItems

The includeEmbeddedItems method includes embedded items in the entry response.

## includeBranch

The includeBranch method includes the branch information in the entry response.

## includeMetadata

The includeMetadata method includes the entry metadata along with the response body.

## variants

The variants method retrieves details of a specific entry variant or an array of entry variants based on the applied query.

When Personalize creates a variant in the CMS, it assigns a "Variant Alias" to identify that specific variant. When fetching entry variants using the Delivery API, you can pass variant aliases in place of variant UIDs in the x-cs-variant-uid header.

Enter the UID/Alias of the variant

## Query

The Get all entries request fetches the list of all the entries of a particular content type. It returns the content of each entry in JSON format. You need to specify the environment and locale of which you want to get the entries. We can apply filters on query also.

## removeHeader

The removeHeader method removes a header from the request using the specified header key.

key of the header you want to remove

## getContentType

The getContentType method retrieves the content type associated with the request.

## where

The where method filters entries by applying a condition that matches a specified field key with the provided value.

key of query parameter

value of query param

## addQuery

The addQuery method adds a custom key-value pair to the query URL, enabling support for extended or non-standard query parameters.

key of query parameter

value of query param

## removeQuery

Remove provided query key from custom query if exist.

Query name to remove.

## and

The and method combines multiple queries using the AND operator to retrieve results that meet all specified conditions.

List of Query instances on which AND query executes.

## or

The or method retrieves all entries that meet any of the specified queries by combining them using the OR operator.

the value that provides an upper bound

## lessThan

The lessThan method applies a constraint that requires a specified key to have a value lower than the given value to retrieve entries.

The key to be constrained

the value that provides an upper bound

## lessThanOrEqualTo

The lessThanOrEqualTo method applies a constraint that requires a specified key to have a value less than or equal to the given value to retrieve entries.

The key to be constrained

The value that must be equalled.

## greaterThan

The greaterThan method applies a constraint that requires a specified key to have a value greater than the given value to retrieve entries.

The key to be constrained

The value that provides an lower bound.

## greaterThanOrEqualTo

The greaterThanOrEqualTo method applies a constraint that requires a specified key to have a value greater than or equal to the given value to retrieve entries.

The key to be constrained

The list of values the key object should not be.

## notEqualTo

The notEqualTo method applies a constraint that requires a specified key to have a value not equal to the given value to retrieve entries.

The key to be constrained

The list of values the key object should not be.

## notContainedIn

Add a constraint to the query that requires a particular key's entry to be contained in the provided array

The key to be constrained

The list of values the key object should not be.

## notContainedIn

The notContainedIn method retrieves entries by applying a constraint that requires a specified key to have a value not contained within the provided array.

The key to be constrained

The list of values the key object should not be.

## exists

The exists method applies a constraint that requires a specified key to be present in the response to retrieve entries.

The key to be constrained

## notExists

Add a constraint that requires, a specified key does not exists in response.

The key to be constrained

## includeReference

The includeReference method adds a constraint that includes the details of a specified reference key in the response to retrieve entries.

key that to be constraineda

## tags

The tags method includes the specified tags as a search criterion in the query to retrieve entries.

Comma separated array of tags with which to search entries.

## ascending

The ascending method sorts the results in ascending order based on the specified key to retrieve entries.

The key to order by.

## descending

The descending method sorts the results in descending order based on the specified key to retrieve entries.

The key to order by.

## only

The only method retrieves entries by specifying an array of keys in the base object that should be included in the response.

## onlyWithReferenceUid

The onlyWithReferenceUid method retrieves entries by specifying an array of only keys that should be included in the response for referenced entries.

Array of the only reference keys to be included in response

Key who has reference to some other class object

## exceptWithReferenceUid

Specifies an array of except keys that would be excluded in the response.

## count

The count method retrieves the total count along with the data objects that match the query criteria.

## includeCount

The includeCount method retrieves the count of objects along with the data in the response that match the specified query conditions.

## includeContentType

The includeContentType method retrieves objects along with the content type details of all returned objects in the response.

## includeOwner

The includeOwner method retrieves objects by including the owner’s profile information in each object’s data.

## skip

The number of objects to skip before returning any.

Number of objects to skip from returned objects

## limit

The limit method retrieves entries by setting a limit on the number of objects to return.

Number of objects to limit.

## regex

The regex method retrieves entries by applying a regular expression constraint that matches string values against the provided pattern, which may result in slower performance for large data sets.

The key to be constrained.

The regular expression pattern to match

Any of the following supported Regular expression modifiers.

\- use i for case-insensitive matching.

\- use m for making dot match newlines.

\- use x for ignoring whitespace in regex

## locale

Set Language using locale code.

language code

## search

The search method retrieves only the entries that match the specified search value.

value used to match or compare

## findOne

The findOne method retrieves entries that match the query conditions and optionally caches the result to improve performance.

The key as string which needs to be added to the Query

## addParam

The addParam method adds a key–value parameter to an entry request.

The key as string which needs to be added to the Query

The value as string which needs to be added to the Query

## includeReferenceContentTypUid

The includeReferenceContentTypeUid method retrieves entries by including the content type UIDs of referenced entries in the response.

## whereIn

The whereIn method retrieves entries by applying conditions to referenced fields and returns those that match the specified values.

The key to be constrained

queryObject is Query object, so you can chain this call

## whereNotIn

The whereNotIn method retrieves entries by applying conditions to referenced fields and returns those that do not match the specified values, functioning as the opposite of the $in query.

The key to be constrained

Query object, so you can chain this call

## includeFallback

The includeFallback method retrieves entries by including fallback language content in the response when content for the specified locale is unavailable.

## includeEmbeddedItems

The includeEmbeddedItems method retrieves entries by including embedded items in the query response.

## includeBranch

The includeBranch method retrieves entries by including branch information in the response.

## includeMetadata

The includeMetadata method retrieves entries by including query metadata in the response body.

## Global Fields

A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type within your stack. This eliminates the need (and thereby time and efforts) to create the same set of fields repeatedly in multiple content types.

**Example:**

import com.contentstack.sdk.\*;
Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
GlobalField globalField = stack.globalField();
globalField.findAll(new GlobalFieldsResultCallback() {
@Override
public void onCompletion(GlobalFieldsModel globalFieldsModel, Error error) {
if(error == null){
JSONArray result = globalFieldsModel.getResultArray();
} else {
System.out.println("❌ Error: " + error.getErrorMessage());
       }
    }
});

## fetch

The fetch method retrieves the details of the specified global field.

UID of the global field

## findAll

The findAll method retrieves the details of all the global fields of the stack.

## includeBranch

The includeBranch method includes the branch details in the result for single or multiple global fields.

## Taxonomy

[Taxonomy](/docs/developers/taxonomy/about-taxonomy) helps you categorize pieces of content within your stack to facilitate easy navigation and retrieval of information.

**Example:**

import com.contentstack.sdk.\*;  
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);  
Taxonomy taxonomy = stack.taxonomy();

## in

The in method retrieves all entries for a specific taxonomy that satisfy the given conditions provided in the $in query.

Enter the UID of the taxonomy

Enter the list of taxonomy fields

## or

The or method retrieves all entries for a specific taxonomy that satisfy at lease one of the given conditions provided in the $or query.

Enter the list of taxonomy fields

## and

The and method retrieves all entries for a specific taxonomy that satisfy all the given conditions provided in the $and query.

Enter the list of taxonomy fields

## exists

The exists method retrieves all entries for a specific taxonomy if the value of the field, mentioned in the condition, exists.

Enter the UID of the taxonomy

Enter true/false

## equalAndBelow

The equalAndBelow method retrieves all entries for a specific taxonomy that match a specific term and all its descendant terms, requiring only the target term.

Enter the UID of the taxonomy

Enter the UID of the term

## below

The below method retrieves all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.

**Note:** If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Enter the UID of the taxonomy

Enter the UID of the term

## equalAbove

The equalAbove method retrieves all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.

**Note:** If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Enter the UID of the taxonomy

Enter the UID of the term

## above

The above method retrieves all entries for a specific taxonomy that match only the parent term(s) of a specified target term, excluding the target term itself and a specified level.

**Note:** If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Enter the UID of the taxonomy

Enter the UID of the term

## find

The find method is used to get API response.

The callback class that contains the API response