Search
K
Yuki Platform API Prod

Get Portal info

This endpoint retrieves information about a portal using its unique portal ID. Ensure you have the necessary permissions before accessing this endpoint. You should have yukiapi:portal:portals:read scope to access this endpoint.

get
https://apirest.yukiworks.com/api/v1/portals/{portal-id}

Path Parameters

portal-idstringrequired

The portal id

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Content-Typestringrequired

Content type, must be application/json

Allowed values:application/json

Response

application/json

Portal object

Portal

idstring

The unique ID of the Portal

Example:3afb7b54-6144-4561-9a29-1148006f2375

namestring

Name of the Portal

Example:Example Portal

countrystring

Country of the Portal in ISO-3166 (2 char) format

contactobject

Contact of the Portal

Show Child Parameters
  
curl --request GET \
  --url https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375 \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "3afb7b54-6144-4561-9a29-1148006f2375",
  "name": "Example Portal",
  "country": "country",
  "contact": {
    "id": "3afb7b54-6144-4561-9a29-1148006f2375",
    "name": "name"
  }
}