Sign in
Discovery Agent

One Discovery Agent profile

A single Discovery Agent profile by ID — the same record the list endpoint returns, fetched directly when you already hold the ID.

Returns 404 when the profile doesn't exist or belongs to a different shop; a profile is only ever visible to the shop that owns it. Unlike the list endpoint this also returns hidden profiles, so a stored ID keeps resolving after a user hides it in the portal.

Single-shop only.

get/discovery/profiles/{profile_id}

Path parameters

profile_idinteger required

Discovery Agent profile ID.

Discovery Agent profile ID.

Response

Successful Response

idinteger required
titlestring required
descriptionstring nullable
search_querystring required
filtersobject nullable
sourcestring required
is_activeboolean required
vault_file_resource_idinteger nullable
is_hiddenboolean required
is_deletedboolean required
hide_unsafeboolean
creator_countinteger required
last_search_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.