Get External ID

  • Updated on Jun 3, 2025
  • Published on Feb 25, 2025
Prev Next
Get
/scheduled-exports/logs/subscription/externalId

Branch provides a unique "external Id" for your Branch account. This should be used when setting up data to be exported to your cloud data service (i.e. S3). NOTE: Developer either needs to provide app_id or organization_id along with accessToken to execute this operation.

Security
appId & accessToken
API Key: appId
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key: accessToken
Header parameter nameaccess-token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

organization_id & accessToken
API Key: organization_id
Query parameter nameorganization_id

organization_id | the organization Id with which the Access Token and subscriptions are associated

API Key: accessToken
Header parameter nameaccess-token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Responses
200

The ID to be used in the Trust Relationship of the Role that you create to allow Branch to access your S3 bucket.

object

Body for external id

external_id
string

A persistent external id against the App Id

ExampleXXXX-0000-xxxx
400

Authentication Failed

Result
"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400
404

Job ID Not Found