Deel: Get Knowledge Hub Country Guides by Country Code
Deel knowledgeHub.getKnowledgeHubCountryGuidesByCountryCode: arguments, response, policy and SDK examples.
← Knowledge hub operations · Get started
Operation deel.knowledgehub_getknowledgehubcountryguidesbycountrycode_v2026_01_01
Provider route: GET /knowledge-hub/country-guide/{country_code}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["knowledgeHub"]["getKnowledgeHubCountryGuidesByCountryCode"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.knowledgeHub.getKnowledgeHubCountryGuidesByCountryCode(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.knowledge_hub.get_knowledge_hub_country_guides_by_country_code(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country_code | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body
Schemas
Section titled “Schemas”Get Knowledge Hub Country Guides by Country Code — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | List of different audiences with associated categories and contract types. |
data[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item |
has_more | boolean | Optional | Indicates if there are more items to fetch. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page of results |
total_count | JSON | Optional | |
total_count (anyOf 1) | number | Alternative | Total number of audiences Format: double |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a specific audience such as Contractor, Client, or Employee. |
categories | array | Optional | List of categories applicable to this audience. |
categories[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item |
contract_types | array | Optional | List of contract types available for this audience. |
contract_types[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item |
name | string | Required within parent | Display name of the audience. |
value | string | Required within parent | Identifier or key representing the audience in lowercase. |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item, Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
articles | array | Required within parent | An array of articles that are connected to this category |
articles[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item |
fields | array | Required within parent | An array of informative fields and it's value that the category contains |
fields[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item |
icon | string | Required within parent | Icon aligning with the category |
id | string | Required within parent | ID for the category |
name | string | Required within parent | Display name of the category |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item, Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
categories | array | Required within parent | List of categories applicable to this audience. |
categories[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item |
name | string | Required within parent | The user friendly name of the contract type |
value | string | Required within parent | Identifier or key representing the contract type in lowercase. |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The timestamp when the article was created Format: date-time |
description | string | Required within parent | An excerpt for the article |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | The date when the article will be effective, meaning the content inside it becomes effective in the real world) Format: date |
effective_date (anyOf 2) | null | Alternative | The date when the article will be effective, meaning the content inside it becomes effective in the real world) Format: date |
featured_image | string | Required within parent | The featured image for the article Format: uri |
id | string | Required within parent | ID for the article |
tags | array | Required within parent | Array of tags inside an article |
tags[] | Model | Each item | Expand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item |
title | string | Required within parent | Title of the article |
type | string | Required within parent | The type of the article, can contain knowledge or compliance Known values: KNOWLEDGE, COMPLIANCE |
updated_at | string | Required within parent | The timestamp when the article was last updated Format: date-time |
Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of the field |
name | string | Required within parent | Title of the field |
type | string | Required within parent | Type of the field, can contain text, link or html Known values: TEXT, LINK, HTML |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value associated for the field |
value (anyOf 2) | null | Alternative | The value associated for the field |
Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID for the tag |
tag | string | Required within parent | Slug for the tag |
title | string | Required within parent | Title of the tag |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.knowledgehub_getknowledgehubcountryguidesbycountrycode_v2026_01_01. Catalog operation: knowledgehub_getknowledgehubcountryguidesbycountrycode_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["knowledge-hub:read"]
Pinned headers: {"X-Version": "2026-01-01"}