Keystone Developers
Open Keystone
API reference

Public API

Blog posts

4 endpoints.

GET/api/v1/public/blog_posts

List published blog posts (public)

Parameters

NameInTypeDescription
pagequeryintegerdefault 1
per_pagequeryintegerdefault 10
X-API-Keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_list_dict_str__Any___
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject[]
object[] fields
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/public/blog_posts/by_slug/{slug}

Get a published blog post by slug (public)

Parameters

NameInTypeDescription
slugrequiredpathstring
X-API-Keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_dict_str__Any__
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/public/blog_posts/recent

List most recent published blog posts (public)

Parameters

NameInTypeDescription
pagequeryintegerdefault 1
per_pagequeryintegerdefault 10
X-API-Keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_list_dict_str__Any___
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredobject[]
object[] fields
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.