Skip to main content
GET
Look up Knowledge by externalId

Query Parameters

externalId
string
required

Partner-supplied externalId to resolve. Sent as a query parameter so ids containing '/' round-trip safely.

provider
string

Disambiguates when more than one provider has used this externalId for the tenant.

Response

Match found

Summary of a Knowledge entry.

id
integer<int64>

GovWorx internal Knowledge id. Use this in subsequent API calls.

Example:

12345

name
string

Human-readable name of the Knowledge entry.

Example:

"Cardiac Arrest - Adult"

description
string

Optional description shown in the GovWorx UI.

source
string

Source of the entry. API_IMPORT indicates it was loaded via this API.

Example:

"API_IMPORT"

provider
string

Identifier of the organization that authored this Knowledge entry. Common values include APCO, PowerPhone, IAED, or a tenant-internal name for in-house authoring.

Example:

"APCO"

knowledgeType
enum<string>

Classification of the Knowledge entry.

Available options:
GUIDE_CARD,
INSTRUCTION_CARD,
POLICY,
MEMO_BRIEFING,
TRAINING,
GENERAL_KNOWLEDGE,
NON_EMERGENCY_LINE_ABILITY
Example:

"GUIDE_CARD"

externalId
string

Partner-supplied identifier if one was provided on create.

Example:

"apco-card-cardiac-arrest-adult"

publishedVersion
integer<int32>

Version number of the currently published version, or null if none is published.

Example:

3

createdAt
string<date-time>

UTC timestamp when this entry was created (i.e., when GovWorx received and stored the first version).

updatedAt
string<date-time>

UTC timestamp when this entry was last modified — a new version was added, the published version changed, or metadata was updated.