Skip to content
Longport WhaleLongport Whale
Misc

Get Flow Tickets With Biz

Queries the approval-flow tickets associated with a business object, so a business view can show that object's approval progress inline.

Request parameters

  • At least one of ids (ticket IDs) and flowKeys (flow keys) must be a non-empty array; if both are omitted or empty the backend returns 400 (ids, flowKeys 是无效的). All other parameters are optional.
  • Filter with any combination of flowKeys, ids, targetType, targetId, targetIds, and status, and control paging with page and pageSize.
  • See each field's own documentation for format, accepted values, and business meaning.

Business notes

This is a shared endpoint of the common ticket-approval system. It typically retrieves the approval tickets linked to a business object identified by targetType plus targetId/targetIds.

Returns

On success, returns the matching approval tickets with pagination. See the response definition below for field meanings.

POSThttps://b-api.lbkrs.com/admin-api/v2/tickets/component

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

flowKeysarray<string>

Submit Flow Keys as a JSON array.

idsarray<string>

Submit Ticket IDs as a JSON array.

targetTypestring

Specifies Target Type. A free-form value (not an enum); provide the actual business value.

targetIdstring

Target ID associated with this request.

targetIdsarray<string>

Submit Target IDs as a JSON array.

statusinteger

Target state to set through this request.

Allowed values: 1 Waiting, 2 Pending, 3 Approved, 4 Rejected, 5 Closed

Values
1
Waiting
2
Pending
3
Approved
4
Rejected
5
Closed
pagenumber

Page number to query, starting from 1.

pageSizenumber

Maximum number of records to return per page. Use a positive integer.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
pageinteger

Page

page_sizeinteger

Page size

ticketsarray<object>

Tickets

Child attributes
idstring

Id

flow_keystring

Flow key

flow_titlestring

Flow title

titlestring

Title

statusinteger

Status

actorobject

Actor

Child attributes
idstring

ID

namestring

Name

emailstring

Email

avatarstring

Avatar

resignedboolean

Resigned

feishu_idstring

Feishu id

callback_errorstring

Callback error

resolved_atstring

Resolved at

created_atstring

Created at

updated_atstring

Updated at

approved_payloadobject

Approved payload

rejected_payloadobject

Rejected payload

front_payloadobject

Front payload

contentstring

Content

target_typestring

Target type

target_idsarray<string>

Target ids

target_preview_urlstring

Target preview url

settingobject

Setting

timelinesarray<object>

Timelines

Child attributes
idstring

ID

typestring

Type

operatorobject

Operator

Child attributes
idstring

ID

namestring

Name

emailstring

Email

avatarstring

Avatar

resignedboolean

Resigned

feishu_idstring

Feishu id

handlersarray<object>

Handlers

Child attributes
idstring

ID

namestring

Name

emailstring

Email

avatarstring

Avatar

resignedboolean

Resigned

feishu_idstring

Feishu id

commentobject

Comment

Child attributes
bodystring

Body

deleted_atstring

Deleted at

idstring

Id

template_idstring

Template id

detail_template_idstring

Detail template id

statusinteger

Status

done_atstring

Done at

created_atstring

Created at

updated_atstring

Updated at

errorstring

Error

settingobject

Setting

capacityobject

Capacity

categorystring

Category

descriptionstring

Description

flow_node_configure_typestring

Flow node configure type

sub_titlesarray<string>

Sub titles

biz_payloadsobject

Biz payloads

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs