Skip to main content
GET
/
api
/
external
/
v1
/
portals
/
{id}
Get Portal
curl --request GET \
  --url https://app.magna.so/api/external/v1/portals/{id} \
  --header 'x-magna-api-token: <api-key>'
{
  "isProcessed": true,
  "result": {
    "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
    }
  }
}

Authorizations

x-magna-api-token
string
header
required

Path Parameters

id
string<uuid>
required
Minimum string length: 1

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.