OmnioDocsAPI referenceOpen the app

Get snippet

GET/v1/snippets/{field_id}

One snippet the caller may use.

Scope content:read

Path parameters

field_idstringRequired

Response

  • 200Success
Response fields
field_idstringRequired
namestringRequired
topicobjectRequired
May be null
topic.idstringRequired
topic.namestringRequired
bodystringRequired
image_keystringRequired
May be null
visibilitystringRequired
team_idstringRequired
May be null
owner_member_idstringRequired
May be null
variablesarray of stringRequired
usage_countintegerRequired
can_editbooleanRequired
created_bystringRequired
May be null
created_atstringRequired
updated_atstringRequired

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 404not_found
  • 422validation_error. details.fields names each field at fault

Every error has the same shape. See Errors.