Skip to main content
GET
/
portals
/
{id}
Retrieves a specific portal by its ID. Access is restricted to the user's own portal.
curl --request GET \
  --url https://api.example.com/portals/{id}
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "customerServicePhone": "<string>",
  "supplierPhone": "<string>",
  "provider": "<string>",
  "alfaECareCompanyCode": "<string>",
  "organisationId": 123
}

Path Parameters

​
id
integer<int32>
required

The unique identifier of the portal.

Response

Successfully retrieved the portal information.

​
id
integer<int32>
​
createdAt
string<date-time>
​
status
enum<integer>
Available options:
1,
2,
3
​
name
string | null
​
customerServicePhone
string | null
​
supplierPhone
string | null
​
provider
string | null
​
alfaECareCompanyCode
string | null
​
organisationId
integer<int32>