Skip to main content
GET
/
v1
/
app-customization
Get App Customization
curl --request GET \
  --url https://api.thefaithapp.com/v1/app-customization \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <x-api-key>'
{
  "use_custom_design": true,
  "release": {},
  "release.payload": {},
  "user": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.thefaithapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the published mobile-app customization payload for the authenticated church.

​
Request inputs

​
X-API-Key
string
required
Your client API key from the dashboard (Settings page).

​
Response fields

​
use_custom_design
boolean
Whether the church has custom mobile-app design enabled at all.
​
release
object
The latest published customization release for this church, or null when no release is available.
​
release.payload
object
The design payload that drives components, navigation, and custom pages in the client app.
​
user
object
required
The current member summary used by the mobile client alongside the design payload.

​
Example response

{
  "use_custom_design": true,
  "release": {
    "id": 6,
    "version": 6,
    "name": "v6",
    "payload": {
      "components": [
        {
          "slug": "video-sermons-carousel-1",
          "type": "carousel",
          "title": "Video Sermons"
        }
      ],
      "navigation": {
        "items": [
          {
            "icon": "home",
            "label": "Home",
            "visibility": "visible"
          }
        ]
      },
      "custom_pages": [
        {
          "slug": "dashboard",
          "title": "Dashboard"
        }
      ]
    }
  },
  "user": {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane@example.com",
    "avatar": null
  }
}