AppForShareGet a token

Docs

CI API reference

The HTTP API the AppForShare CLI uses. Call it from any CI, script or tool to upload builds, find the newest one, move it between channels, read tester feedback and manage testers. Pro and Team; parts marked Team need a Team workspace.

Base URL: https://appforshare.io/api

Auth: Authorization: Bearer afs_... with an API token from Settings

Format: JSON in and out, except chunks (raw bytes) and file downloads. Errors answer with a message field.

OpenAPI: https://appforshare.io/api/ci/openapi.json (OpenAPI 3.1, every route on this page, for Postman, Zapier, Make and n8n). For a Custom GPT see ChatGPT Actions.

Upload a build

Uploads are resumable: create the upload, send the file in chunks of up to 32 MB, then complete it. After a dropped connection, read the status to get the offset and go on from there. The X-Upload-Token from the first answer goes with every later call. This is the flow the CLI, GitHub Action, fastlane and Gradle plugins use.

POST/uploadsChanges data

Start an upload. fileName ends in .ipa, .apk or .aab; size is in bytes. Optional: releaseNotes (Pro and Team), channel (created on first use, Pro and Team), password for the install link (4 to 128 characters), emails to send the install link to when it is ready (up to 5, Pro and Team), groups and testers to share the build with when it is ready (Team, up to 100 each). startAt (ISO date and time, Pro and Team): the link opens for installs then, and the tester emails for this build (new build notice, groups and testers, emails) go out at that moment instead of when it is ready. fileName may also end in .zip for an iOS app: a zipped .app folder is turned into an .ipa. Answers id, token, chunkBytes and offset.

curl -s -X POST https://appforshare.io/api/uploads \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"fileName":"app-release.apk","size":48211337,"releaseNotes":"Fixes the login crash","channel":"beta","groups":["Client QA"]}'
# {"id":"Q3vF8kL2mN0pR7sT","token":"...","chunkBytes":33554432,"offset":0}

PUT/uploads/:id?offset=NChanges data

Send the next chunk as raw bytes, starting at offset. The answer is the new offset. A wrong offset answers 409 with the offset to use.

split -b 32m app-release.apk part_
offset=0
for p in part_*; do
  curl -s -X PUT "https://appforshare.io/api/uploads/$ID?offset=$offset" \
    -H "X-Upload-Token: $UPLOAD_TOKEN" -H "Content-Type: application/octet-stream" \
    --data-binary @"$p"
  offset=$((offset + $(wc -c < "$p")))
done

POST/uploads/:id/completeChanges data

Finish the upload. The build is queued for processing.

curl -s -X POST https://appforshare.io/api/uploads/$ID/complete -H "X-Upload-Token: $UPLOAD_TOKEN"

GET/uploads/:id

Status: UPLOADING (with the offset received so far), QUEUED, PROCESSING, READY or FAILED (with error). When READY it has the install link url, the slug, expiresAt and, with a channel, the channel link.

curl -s https://appforshare.io/api/uploads/$ID -H "X-Upload-Token: $UPLOAD_TOKEN"
# {"id":"Q3vF8kL2mN0pR7sT","status":"READY","url":"https://appforshare.io/i/Stw0Ae","slug":"Stw0Ae","channel":{"name":"beta","url":"https://appforshare.io/c/..."},...}

Account and builds

A build is addressed by its id or its link slug (:ref).

GET/ci/whoami

Email, workspace, role and plan of the token.

curl -s https://appforshare.io/api/ci/whoami -H "Authorization: Bearer $APPFORSHARE_TOKEN"

GET/ci/projects

Projects with their ids and whether they are public or private to invited testers.

GET/ci/builds

Recent builds, newest first. Filters: platform (ios or android), app (bundle id or package name), project, channel, limit (1 to 100, default 20).

curl -s "https://appforshare.io/api/ci/builds?platform=android&app=com.example.shop&limit=5" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

GET/ci/builds/latest

The newest build that matches the same filters, or 404 when there is none. With channel: the build in that channel.

curl -s "https://appforshare.io/api/ci/builds/latest?channel=beta&platform=ios" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

GET/ci/builds/:ref

One build with its release notes, the store readiness report (status and each finding with a fix) and, on Pro and Team, the crash dashboard link for that version and verifiedPublisher (the "Shared by" line install pages show, or null).

DELETE/ci/builds/:refChanges data

Delete a build. It can be restored from the dashboard for 7 days. Developer role.

GET/ci/builds/:ref/installs

Who installed a build, newest first (up to 200): time, device, OS version, model, country and the tester when known, with the total and counts by device and country.

curl -s https://appforshare.io/api/ci/builds/Stw0Ae/installs -H "Authorization: Bearer $APPFORSHARE_TOKEN"
# {"slug":"Stw0Ae","total":12,"byDevice":{"IOS":9,"ANDROID":3},"byCountry":{"PK":7,"US":5},"items":[...]}

POST/ci/builds/:ref/emailChanges data

Email the install link to up to 5 addresses: one plain mail per build and address, with no tracking. An address that already got this build is skipped. Up to 50 addresses a day per account. Refused for projects open only to invited testers (add them as testers) and for links that no longer work. Pro and Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/email \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"emails":["[email protected]","[email protected]"]}'
# {"slug":"Stw0Ae","sent":["[email protected]","[email protected]"],"skipped":[]}

Channels, links and release checklist

POST/ci/builds/:ref/channelChanges data

Put a build into a channel (created when missing); an older build is a rollback of the link. On Team a gated channel answers 409 with what is missing; force: true works for an Admin token. Pro and Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/channel \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"channel":"live"}'

PATCH/ci/builds/:ref/linkChanges data

Link controls: paused (true or false), startAt (opens for installs at this ISO date and time, or null to open now), stopAt (an ISO date and time, or null), maxInstalls (a number, or null). The start must be before the stop date. Before the start the install page shows the opening time and the iOS manifest and download answer 403 with reason OWNER_NOT_YET; channels and the update check keep the build before until it opens. Answers paused, startAt, opensAt (null once open), stopAt, maxInstalls and installs. Setting needs Pro or Team; removing works on any plan. Developer role.

curl -s -X PATCH https://appforshare.io/api/ci/builds/12345/link \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"startAt":"2026-12-01T09:00:00Z","stopAt":"2026-12-31T23:59:59Z","maxInstalls":50}'

POST/ci/builds/:ref/retireChanges data

Retire a broken build, with an optional reason (up to 200 characters) shown to testers: its link takes no installs and sends testers to the newest build of the same app and platform, channels skip it, and the update check reports it. Answers retired, reason and newer (slug, version, versionCode, or null). DELETE on the same path brings it back (any plan). Pro and Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/retire \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"reason":"Crashes on login"}'

GET/ci/builds/:ref/links

Extra share links of a build: id, slug, url, label, hasPassword, startAt, opensAt, expiresAt, maxInstalls, installs and state (LIVE, or HELD (held for review by AppForShare staff), OWNER_RETIRED, OWNER_PAUSED, OWNER_NOT_YET, OWNER_STOPPED or OWNER_LIMIT when it takes no installs), with limit and used.

curl -s https://appforshare.io/api/ci/builds/12345/links -H "Authorization: Bearer $APPFORSHARE_TOKEN"

POST/ci/builds/:ref/linksChanges data

Add an extra share link: label (1 to 60 characters), optional password (4 to 128 characters, only this link's password applies on it), startAt (opens for installs at this ISO date and time; the later of the build start and the link start applies), expiresAt (stop date, ISO date and time, after the start) and maxInstalls. It opens the same install page with its own install count; installs also count in the build's total, and the build's own pause, stop date and limit apply to it. Pro up to 3 per build, Team up to 20. Developer role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/links \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"label":"Client A","password":"acme-2026","expiresAt":"2026-12-31T23:59:59Z","maxInstalls":25}'
# {"id":7,"slug":"Qm3xT9","url":"https://appforshare.io/i/Qm3xT9","label":"Client A","hasPassword":true,...}

PATCH/ci/links/:linkChanges data

Change one extra link by its slug: label, password, startAt, expiresAt, maxInstalls. Fields left out stay as they are; null removes a password, start time, stop date or cap. Developer role.

DELETE/ci/links/:linkChanges data

Turn off one extra link. Its page then says the link was turned off; the build and its other links keep working, and the slug is never given out again. Developer role.

GET/ci/builds/:ref/codes

Per tester access codes of a build's own page; ref can also be the slug of an extra link, for that link's codes. Each item: id, label, maxInstalls (devices it allows), installs, state (ACTIVE, USED or REVOKED), link, lastUsedAt, revokedAt, createdBy and createdAt, with allowed (whether the plan makes new ones), limit (25) and used. GET /ci/links/:link/codes lists one extra link's codes.

curl -s https://appforshare.io/api/ci/builds/12345/codes -H "Authorization: Bearer $APPFORSHARE_TOKEN"

POST/ci/builds/:ref/codesChanges data

Make a one off access code: label (1 to 60 characters, for the person or client, never shown to testers) and maxInstalls (devices, 1 to 50, default 1). The answer has the plain code in code; it is the only time it is shown, since only a fingerprint is kept. A tester types it on the install page instead of the shared password; each install takes one device off it. Up to 25 per page. POST /ci/links/:link/codes does the same for one extra link. Team, Owner or Admin role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/codes \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"label":"Ana at Client A","maxInstalls":2}'
# {"id":41,"label":"Ana at Client A","maxInstalls":2,"installs":0,"state":"ACTIVE","code":"K7QM-T3XA",...}

POST/ci/codes/:id/revokeChanges data

Revoke one access code. It stops opening the page at once, also halfway through an install; installs made with it stay, and the password and other codes keep working. Any plan, Owner or Admin role.

DELETE/ci/codes/:idChanges data

Delete one access code from the list. It stops working; who installed keeps its label. When a page's last code goes, the page no longer asks for a code. Owner or Admin role.

GET/ci/builds/:ref/test-logins

Test accounts of a build: items (username, note, hasPassword; never the password), allowed, limit (3), used, and shown (false when the page has no password, no access codes and is not private, so testers would not see them). GET /ci/channels/test-logins?channel=beta&app=com.example.shop lists a channel's.

curl -s https://appforshare.io/api/ci/builds/12345/test-logins -H "Authorization: Bearer $APPFORSHARE_TOKEN"

POST/ci/builds/:ref/test-loginsChanges data

Add a test account testers see on the install page: username, password (1 to 200 characters each) and an optional note (300). The same username replaces its password and note. Up to 3 per build or channel, stored encrypted. Shown only behind the page password or an access code, or to invited testers of a private project; never in emails, webhooks, MCP answers or the update check. Use test accounts only. POST /ci/channels/test-logins takes channel plus app or project in the same body. Pro and Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/test-logins \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"username":"[email protected]","password":"'"$TEST_PASSWORD"'","note":"Admin role"}'

POST/ci/builds/:ref/test-logins/removeChanges data

Remove one test account ({"username":"[email protected]"}) or all of them ({"all":true}). Any plan, Developer role. POST /ci/channels/test-logins/remove does the same for a channel.

PUT/ci/channels/addressChanges data

Give a channel its own address, /c/<slug>: 3 to 40 lower case letters, digits and hyphens, unique on AppForShare, some words reserved. The old address redirects the page for 30 days and the in-app update check on it keeps working. An address is never given to anyone else. Name the app with app (bundle id) or project. Pro and Team, Developer role.

curl -s -X PUT https://appforshare.io/api/ci/channels/address \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"channel":"beta","app":"com.example.shop","slug":"acme-beta"}'

PUT/ci/channels/testflightChanges data

Add the TestFlight public link to a channel (url), or remove it (url: null). Name the app with app (bundle id) or project. Pro and Team, Developer role.

curl -s -X PUT https://appforshare.io/api/ci/channels/testflight \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"channel":"beta","app":"com.example.shop","url":"https://testflight.apple.com/join/AbCd1234"}'

GET/ci/channels/followers?channel=beta&app=com.example.shop

People who follow a channel by email ("Email me new builds" on its page): confirmed and pending counts, the plan cap (200 on Pro, 2,000 on Team) and masked addresses such as jo***@example.com, never the full ones. POST /ci/channels/followers/remove with {"channel","app","email"} removes one address. Pro and Team; removing needs the Developer role.

GET/ci/builds/:ref/release

The release checklist of a build with its ticks, named approvals (approver, approved or rejected with a note, or pending), open release blockers and whether the gated channel takes it. Approvals are read here, never given: the approver answers on the build page. Team.

PUT/ci/builds/:ref/release/checks/:keyChanges data

Tick or untick one step. Approval steps answer 409 (they are approved by their approver in the dashboard). Developer role. Team.

curl -s -X PUT https://appforshare.io/api/ci/builds/12345/release/checks/a1b2c3d4 \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" -d '{"done":true}'

GET/ci/releases?app=<bundle id>

Versions of an app (or ?project=<id>) with their build count and platforms, newest first. Team; Pro read only.

GET/ci/releases/:version?app=<bundle id>

The release page of one version: its iOS and Android builds with channels and store readiness, checklist and approvals of the newest build per platform (Team; null on Pro), release blockers, App Store and Google Play state, and a timeline. A bundle id or package name finds the project of its newest build; ?project=<id> works too.

curl -s "https://appforshare.io/api/ci/releases/2.4.0?app=com.example.shop" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

GET/ci/builds/:ref/test-plan/export?format=firebase|maestro

The AI test plan of the build as a YAML file: Firebase App Testing agent test cases (run with firebase apptesting:execute --test-dir; Android only, in preview) or a Maestro starter flow. The build needs a plan first. Pro and Team.

curl -s "https://appforshare.io/api/ci/builds/12345/test-plan/export?format=firebase" \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -o tests/app-testing.yaml

Feedback and activity

GET/ci/feedback

Tester feedback, newest first: message, kind, device, build, whether it came from the in-app feedback link with its screen, how many screenshots, and a dashboard link. Filters: build (id or slug), status (open, resolved or all; default open).

curl -s "https://appforshare.io/api/ci/feedback?build=Stw0Ae&status=open" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

POST/ci/feedback/:id/trackerChanges data

Make a Linear or Jira issue from a report, with its screenshots, once a tracker is connected. Sent once per report. Pro and Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/feedback/678/tracker \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" -d '{"tracker":"jira"}'

POST/ci/feedback/:id/repliesChanges data

Reply to a report: kept in its thread (the thread field of GET /ci/feedback) and emailed once to the tester in the language of their install page, with a link to answer once there. Only reports with a tester email, not TestFlight; text up to 2000 characters; up to 20 messages per report and 5 replies per report a day. Team, Developer role.

curl -s -X POST https://appforshare.io/api/ci/feedback/678/replies \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" -d '{"text":"Fixed in build 52, please try again."}'

POST/ci/feedback/:id/taskChanges data

Add a task from a report to its project's task board, linked to the build. Team, Developer role.

GET/ci/activity

Workspace activity, newest first. Filters: project, kind (build, channel, feedback, task, release, link, tracker, tester), before (an activity id, for the next page), limit (1 to 100, default 50). Team.

curl -s "https://appforshare.io/api/ci/activity?kind=channel&limit=20" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

Diawi compatible upload

For scripts and plugins written for the Diawi API: change the URL and the token and they upload here. One request carries up to 100 MB; for bigger builds use the resumable upload above or the CLI. The token goes in the token field, or as Authorization: Bearer. Pro and Team.

POST/ci/diawiChanges data

Multipart form with token and file (.ipa, a zipped .app, .apk or .aab). Optional: password, comment (becomes the release notes), callback_url (https; called once with the result when the build is ready or failed), callback_emails (up to 5 addresses, comma separated; each gets the install link). installation_notifications, find_by_udid and wall_of_apps are accepted and ignored. Answers a job id.

curl https://appforshare.io/api/ci/diawi -F token=$APPFORSHARE_TOKEN -F [email protected] -F comment="Fixes the login crash"
# {"job":"Q3vF8kL2mN0pR7sT"}

GET/ci/diawi/status?token=&job=

Status of the job, with Diawi's codes: 2001 still processing, 2000 done (hash = link code, link = install page, qrcode = PNG of the QR code), 4000 failed (message says why).

curl -s "https://appforshare.io/api/ci/diawi/status?token=$APPFORSHARE_TOKEN&job=Q3vF8kL2mN0pR7sT"
# {"status":2000,"message":"Ok","hash":"Stw0Ae","link":"https://appforshare.io/i/Stw0Ae","qrcode":"https://appforshare.io/i/Stw0Ae/qr"}

Pgyer and Loadly compatible upload

For scripts and plugins written for the Pgyer API v2, which Loadly uses too: change the base URL to https://appforshare.io/api/ci/pgyer and put an AppForShare token in _api_key (or Authorization: Bearer). Answers use Pgyer's shape, { code, message, data }, where code 0 means done and any other code is an error; 1247 means still processing. One request carries up to 100 MB; for bigger builds use the CLI. Pro and Team.

POST/ci/pgyer/apiv2/app/uploadChanges data

Multipart form with _api_key and file (.ipa, a zipped .app, .apk or .aab). Mapped: buildInstallType 1 (public) or 2 (password), buildPassword, buildUpdateDescription (release notes), buildInstallDate 1 with buildInstallStartDate and buildInstallEndDate (a day such as 2026-12-31 or an ISO date and time; a day as the end means the end of that day, UTC), buildChannelShortcut (a channel address or name). buildInstallType 3 (invitation) and every other field are accepted and ignored, and the answer lists them in data.ignored. Waits up to 60 seconds for the build and answers with it: buildKey, buildShortcutUrl (the link code), buildQRCodeURL, version fields, plus buildUrl and the store readiness result. A build that takes longer answers 1247 with the buildKey for buildInfo.

curl https://appforshare.io/api/ci/pgyer/apiv2/app/upload -F _api_key=$APPFORSHARE_TOKEN -F [email protected] -F buildUpdateDescription="Fixes the login crash"
# {"code":0,"message":"","data":{"buildKey":"Q3vF8kL2mN0pR7sT","buildShortcutUrl":"Stw0Ae","buildQRCodeURL":"https://appforshare.io/i/Stw0Ae/qr","buildUrl":"https://appforshare.io/i/Stw0Ae","readiness":{"status":"ready","findings":[]},...}}

POST/ci/pgyer/apiv2/app/getCOSTokenChanges data

Pgyer's two step upload: the same fields without the file, plus buildType (ios or android). Answers endpoint, key and params. POST a multipart form to the endpoint with the params (key, signature, x-cos-security-token) and file; it answers 204. Each key takes one file. Then poll buildInfo with the key.

curl -s https://appforshare.io/api/ci/pgyer/apiv2/app/getCOSToken -d _api_key=$APPFORSHARE_TOKEN -d buildType=android

GET/ci/pgyer/apiv2/app/buildInfo?_api_key=&buildKey=

The build of an upload: code 1247 while it is processing, 1216 when it failed (message says why), 0 with the build. Also takes POST and a link code as buildKey.

curl -s "https://appforshare.io/api/ci/pgyer/apiv2/app/buildInfo?_api_key=$APPFORSHARE_TOKEN&buildKey=Q3vF8kL2mN0pR7sT"

POST/ci/pgyer/apiv2/app/check

Update check against one of your channels: appKey is the channel address (the part after /c/), buildVersion or buildBuildVersion is what the app has, buildType (ios or android) is needed when the channel has both. Answers buildHaveNewVersion, downloadURL (the install page) and the newest build's fields. needForceUpdate is always false; for apps in testers' hands the public update check needs no token.

curl -s https://appforshare.io/api/ci/pgyer/apiv2/app/check -d _api_key=$APPFORSHARE_TOKEN -d appKey=acme-beta -d buildBuildVersion=4

Testers and groups (Team)

Emails go in lists of up to 100 per call. An account can have up to 1,000 testers. Changes need the Developer role.

GET/ci/testers

Testers with their projects and groups. Filters: project, group (name).

curl -s "https://appforshare.io/api/ci/testers?group=Client%20QA" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

POST/ci/testersChanges data

Add testers: emails, optional project and groups (names). New testers get an invite unless notify is false.

curl -s -X POST https://appforshare.io/api/ci/testers \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"emails":["[email protected]","[email protected]"],"project":42,"groups":["Client QA"]}'

POST/ci/testers/importChanges data

Import a CSV as text: an email column, name or first and last name columns, a groups column (semicolon or pipe between several). Groups are made when missing. Up to 1,000 rows; invites only with notify: true, and then up to 200 new testers per import.

jq -Rs '{text: ., groups: ["Beta"]}' testers.csv | curl -s -X POST https://appforshare.io/api/ci/testers/import \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" --data @-

POST/ci/testers/import-groupsChanges data

Tester groups with their testers from another service, as appforshare import bitrise sends them: source (bitrise), the app name for the activity line, optional project, up to 100 groups of up to 1,000 testers each (email, optional name). Groups are matched by name in any case or made, a tester in two groups becomes one tester in both. Invites only with notify: true. Answers added, updated, invited and groupsCreated. The Bitrise token is never part of the call.

curl -s -X POST https://appforshare.io/api/ci/testers/import-groups \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"source":"bitrise","app":"Notes","groups":[{"name":"QA Team","testers":[{"email":"[email protected]","name":"Ana"}]}]}'

POST/ci/testers/removeChanges data

With project: take away the access you gave by hand in that project (access through a group stays). Without: remove the testers from the workspace.

GET/ci/tester-groups

Groups with member counts and their projects.

POST/ci/tester-groupsChanges data

Make a group: name, optional project.

DELETE/ci/tester-groups/:nameChanges data

Delete a group. Its members stay testers.

POST/ci/tester-groups/:name/membersChanges data

Add members by email (made testers when new); notify defaults to true.

POST/ci/tester-groups/:name/members/removeChanges data

Take members out of a group.

POST/ci/builds/:ref/distributeChanges data

Share an uploaded build with groups and testers: the groups get its project, new addresses become testers, and they are emailed its install link (at most one email per tester per project in an hour). Up to 100 groups and testers together.

curl -s -X POST https://appforshare.io/api/ci/builds/12345/distribute \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"groups":["Client QA"],"testers":["[email protected]"]}'

GitHub builds

Runs of the iOS and Android builds AppForShare started on your GitHub Actions (Pro and Team).

GET/ci/github-runs

Recent runs, newest first (limit 1 to 100, default 20): repository, platform, result, branch, commit, log link, the build it made and whether a failed run has an AI explanation.

curl -s "https://appforshare.io/api/ci/github-runs?limit=10" -H "Authorization: Bearer $APPFORSHARE_TOKEN"

GET/ci/github-runs/:id

One run with its AI explanation when there is one: category, cause, fix steps, confidence and the failed step.

POST/ci/github-runs/:id/explainChanges data

Explain a failed or timed out run: AppForShare reads the failed job's log, takes secrets out and asks AI for the likely cause and the fix (1 AI action). An existing explanation comes back as is unless fresh: true. Developer role.

curl -s -X POST https://appforshare.io/api/ci/github-runs/42/explain \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" -d '{}'

Connect Expo

The Expo Build (EAS Build) webhook of a project (Pro and Team). Expo calls the address with an expo-signature header; finished internal builds are fetched from Expo and uploaded into the project.

GET/ci/projects/:id/eas

State of Connect Expo: the webhook address and secret (Developer role and up), the eas webhook:create commands, the build profile to channel map and the latest imports with their status.

POST/ci/projects/:id/easChanges data

Turn it on, or change it: profiles as "preview=Beta, development=Dev" pairs, rotate: true for a new address and secret (the old ones stop at once). Developer role.

curl -s -X POST https://appforshare.io/api/ci/projects/42/eas \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"profiles":"preview=Beta"}'

DELETE/ci/projects/:id/easChanges data

Turn Connect Expo off for the project. Developer role.

POST/hooks/eas/:token

Where Expo sends BUILD and SUBMIT webhooks. No API token: the expo-signature header (HMAC-SHA1 of the body with the secret) is checked first. Store and simulator builds are skipped, errored builds go to build.failed webhooks, submissions add a line to the release timeline.

Build history page

The public page /h/<code> of a project with its last 20 builds and an Install button each (Pro and Team, off until turned on). Every build keeps its own password, link controls and private project rule.

GET/ci/projects/:id/history

Whether the page is on, its address and whether it has a password of its own.

PUT/ci/projects/:id/historyChanges data

Turn it on or off: on: true or false; password: a page password (4 to 128 characters), null to remove it, left out to keep it; reset: true for a new address (the old one stops working). Turning it off removes the page password too. Developer role.

curl -s -X PUT https://appforshare.io/api/ci/projects/42/history \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"on":true}'

DELETE/ci/projects/:id/historyChanges data

Turn the page off. Developer role.

Connect Codemagic

The workspace's Codemagic API token and its Codemagic workflow to project mappings (Pro and Team). Every 5 minutes AppForShare reads the finished builds of each mapped workflow from the Codemagic Builds API and imports the .ipa, .apk or .aab once per build and platform. The token is never sent back.

GET/ci/codemagic?project=:id

State: whether a token is saved (and by whom), the last check, the mappings (Codemagic app, workflow, project, channel) and the latest imports with their status. Without project, the whole workspace.

POST/ci/codemagicChanges data

Save the token (token, checked with Codemagic first), map a workflow (appId, workflowId, projectId, optional channel and teamId), or both in one call. The token is needed the first time only. Owner or Admin.

curl -s -X POST https://appforshare.io/api/ci/codemagic \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" \
  -d '{"token":"'"$CM_API_TOKEN"'","appId":"5fabc6414c483700143f4f92","workflowId":"android-beta","projectId":42,"channel":"Beta"}'

DELETE/ci/codemagic/links/:idChanges data

Remove one workflow mapping. Owner or Admin.

DELETE/ci/codemagic?project=:idChanges data

With project, remove that project's mappings and keep the token. Without project, delete the token and every mapping. Owner or Admin.

Devices

POST/ci/devices/importChanges data

Import iPhone and iPad UDIDs as text: Firebase's Export Apple UDIDs file, Apple's Register Multiple Devices file, one UDID per line with an optional name, or the JSON of eas device:list --json. Up to 1,000 per call. Answers added, known, named and the skipped lines with a reason. Developer role.

jq -Rs '{text: .}' firebase-udids.txt | curl -s -X POST https://appforshare.io/api/ci/devices/import \
  -H "Authorization: Bearer $APPFORSHARE_TOKEN" -H "Content-Type: application/json" --data @-

GET/ci/devices/apple-devices.txt

Your devices in Apple's Register Multiple Devices format, for the Apple portal or fastlane register_devices.

curl -s https://appforshare.io/api/ci/devices/apple-devices.txt -H "Authorization: Bearer $APPFORSHARE_TOKEN" -o devices.txt

Questions

Which plan do I need?
API tokens come with Pro and Team. Testers, groups, distribute, the release checklist, tasks and activity need Team. Make a token under Dashboard, Settings, API tokens.
What can a token do?
The same as its creator in that workspace, with their role: a Viewer token only reads. Revoke a token in Settings and it stops at once.
Is there a rate limit?
Yes. Adding testers, adding group members and distribute share 20 calls an hour per workspace, tester imports 10 an hour and device imports 30 an hour. An answer of 429 means wait and try again.
Do I have to use the API?
No. The CLI does all of this with one command per job, and the GitHub Action, fastlane plugin and MCP server use the same calls.
I have a script that uploads to Diawi. Do I rewrite it?
No. Point it at https://appforshare.io/api/ci/diawi and its status call at /api/ci/diawi/status, and use an AppForShare token. The field names and status codes are the same. See the move from Diawi guide.
My script uploads to Pgyer or Loadly. Does it work here?
Yes, when you can change its base URL. Point it at https://appforshare.io/api/ci/pgyer (paths such as /apiv2/app/upload stay the same) and put an AppForShare token in _api_key. Invitation installs and fields we have no match for are accepted and ignored, and the answer lists them.

Prefer commands? See the CLI, GitHub Action, fastlane and Gradle guide. Coming from Diawi? Read the move from Diawi guide. Or connect an AI tool through the MCP server, or ChatGPT through Custom GPT Actions.

Send every iOS and Android build your pipeline makes to AppForShare, and your testers get the install link right away. One API token, one command, and it works in any CI or your terminal. Watch on YouTube