Console API

Platform admins

5 endpoints.

POST/api/v1/admin/platform-admin-invites/{invite_id}/accept

Accept a pending Keystone Admin invite for the authenticated user

Parameters

Name	In	Type	Description
`invite_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PlatformAdminUserData_

Field Type Description

request_idrequired string

success true default true

datarequired

PlatformAdminUserData

PlatformAdminUserData fields

Field	Type	Description
`id`required	`string`
`kind`required	`string`
`first_name`	`string`	default ""
`last_name`	`string`	default ""
`email`required	`string (email)`
`phone`	`string \| null`
`role`required	`string`
`status`required	`string`
`delivery_status`	`string \| null`
`joined_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

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

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/users

List Keystone Admins and pending admin invites

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_PlatformAdminUserData__

Field Type Description

request_idrequired string

success true default true

datarequired

PlatformAdminUserData[]

PlatformAdminUserData[] fields

PlatformAdminUserData, expanded above.

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/users

Invite a Keystone Admin (pending invite + email)

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonPlatformAdminInviteBody

Field	Type	Description
`email`required	`string (email)`
`phone`	`string \| null`

Responses

201Successful Response

application/jsonSuccessResponse_PlatformAdminUserData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PlatformAdminUserData`	PlatformAdminUserData fields PlatformAdminUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/admin/users/{entry_id}

Update a Keystone Admin or pending admin invite

Parameters

Name	In	Type	Description
`entry_id`required	path	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonPlatformAdminUpdateBody

Field	Type	Description
`first_name`required	`string`
`last_name`required	`string`
`email`required	`string (email)`
`phone`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PlatformAdminUserData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PlatformAdminUserData`	PlatformAdminUserData fields PlatformAdminUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/users/{entry_id}

Remove pending admin invite or demote a Keystone Admin

Parameters

Name	In	Type	Description
`entry_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

204Successful Response

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

Error bodies: ErrorResponse. See Errors.