Skip to main content
Retrieve a single claim portal by ID, including its configuration, claim config, and auth settings. Route: GET /api/external/v1/portals/{id}

Headers

HeaderRequiredDescription
Content-TypeYesMust be application/json
x-magna-api-tokenYesYour Magna API token

Path parameters

ParameterTypeDescription
idstring (uuid)The portal ID

Request example

curl -X GET 'https://app.magna.so/api/external/v1/portals/{portal_id}?id={portal_id}' \
-H 'Content-Type: application/json' \
-H 'x-magna-api-token: YOUR_API_KEY'

Response example

{
  "id": "po...uuid",
  "name": "Acme Claim Portal",
  "projectId": "p...uuid",
  "domains": ["acme.demo-portal.magna.so"],
  "legalEntityName": "Acme Inc.",
  "version": "V2",
  "configuration": { "...": "version-specific portal configuration" },
  "createdAt": "2024-04-15T21:26:21.000Z",
  "updatedAt": "2024-04-15T21:26:21.000Z",
  "claimConfig": {
    "tokenId": "tok...uuid",
    "contractId": "c...uuid",
    "startTimestamp": "2024-05-01T00:00:00.000Z",
    "endTimestamp": null
  },
  "auth": { "magnaApiToken": null, "terminal3": null, "x": null }
}