Keystone Developers
Open Keystone
API reference

Public API

Team members

2 endpoints.

GET/api/v1/public/team_members

List team members

All team members for the business, ordered by display_order. Paginated.

Parameters

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

Responses

200Successful Response
application/jsonSuccessResponse_list_PublicTeamMember__
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredPublicTeamMember[]
PublicTeamMember[] fields
FieldTypeDescription
idrequiredstring
namestring | null
rolestring | null
positionstring | null
bio_markdownstring | null
photo_attachmentsPublicPhotoAttachment[]
PublicPhotoAttachment[] fields

Nested object (not expanded)

featuredbooleandefault false
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.