DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Approvals

GET
/organizations/{organizationId}/approvals
List approval flows
Parameter query
pageToken
string
The cursor that keeps track of the current position in the results.
limit
integer
Limits the number of results to return.
reverse
boolean
Reverses the order in which the results are returned.
status
string
Possible values: active, deleted
objectType
string
objectAction
string
Possible values: create, update, delete
tags
string
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.organizationId
string
results.workspaceId
string
results.ownerId
string
wajib
results.name
string
wajib
results.description
string
wajib
results.objectType
string
wajib
The identifier of the object
results.objectAction
string
wajib
The action performed on the object
Possible values: create, update, delete
results.steps
array of object
wajib
Tampilkan atribut turunan
results.steps.type
string
wajib
Possible values: any, all
results.steps.users
array of string
wajib
results.steps.reviewers
array of object
Tampilkan atribut turunan
results.steps.reviewers.type
string
wajib
Possible values: user
results.steps.reviewers.id
string
wajib
results.steps.message
string
results.createdAt
string
wajib
results.updatedAt
string
wajib
results.tags
array of object
Tampilkan atribut turunan
results.tags.key
string
wajib
results.tags.value
string
wajib
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Contoh kode
curl -X GET 'https://api.bird.com/organizations/{organizationId}/approvals' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/organizations/{organizationId}/approvals
Create approval flow
Payload permintaan
name
string
wajib
description
string
wajib
objectType
string
wajib
The identifier of the object
objectAction
string
wajib
The action performed on the object
Possible values: create, update, delete
tags
array of object
Tampilkan parameter turunan
tags.key
string
wajib
tags.value
string
wajib
steps
array of object
wajib
Tampilkan parameter turunan
steps.type
string
wajib
Possible values: any, all
steps.users
array of string
steps.reviewers
array of object
Tampilkan parameter turunan
steps.reviewers.type
string
wajib
Possible values: user
steps.reviewers.id
string
wajib
steps.message
string
Payload respons
id
string
wajib
organizationId
string
workspaceId
string
ownerId
string
wajib
name
string
wajib
description
string
wajib
objectType
string
wajib
The identifier of the object
objectAction
string
wajib
The action performed on the object
Possible values: create, update, delete
steps
array of object
wajib
Tampilkan atribut turunan
steps.type
string
wajib
Possible values: any, all
steps.users
array of string
wajib
steps.reviewers
array of object
Tampilkan atribut turunan
steps.reviewers.type
string
wajib
Possible values: user
steps.reviewers.id
string
wajib
steps.message
string
createdAt
string
wajib
updatedAt
string
wajib
tags
array of object
Tampilkan atribut turunan
tags.key
string
wajib
tags.value
string
wajib
Contoh kode
curl -X POST 'https://api.bird.com/organizations/{organizationId}/approvals' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/organizations/{organizationId}/approvals/{approvalId}
Retrieve approval flow
Payload respons
id
string
wajib
organizationId
string
workspaceId
string
ownerId
string
wajib
name
string
wajib
description
string
wajib
objectType
string
wajib
The identifier of the object
objectAction
string
wajib
The action performed on the object
Possible values: create, update, delete
steps
array of object
wajib
Tampilkan atribut turunan
steps.type
string
wajib
Possible values: any, all
steps.users
array of string
wajib
steps.reviewers
array of object
Tampilkan atribut turunan
steps.reviewers.type
string
wajib
Possible values: user
steps.reviewers.id
string
wajib
steps.message
string
createdAt
string
wajib
updatedAt
string
wajib
tags
array of object
Tampilkan atribut turunan
tags.key
string
wajib
tags.value
string
wajib
Contoh kode
curl -X GET 'https://api.bird.com/organizations/{organizationId}/approvals/{approvalId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/organizations/{organizationId}/approvals/{approvalId}
Delete approval flow
Contoh kode
curl -X DELETE 'https://api.bird.com/organizations/{organizationId}/approvals/{approvalId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/approvals/{approvalId}
Update approval flow
Payload permintaan
name
string
description
string
objectType
string
objectAction
string
Possible values: create, update, delete
steps
array of object
Tampilkan parameter turunan
steps.type
string
wajib
Possible values: any, all
steps.users
array of string
steps.reviewers
array of object
Tampilkan parameter turunan
steps.reviewers.type
string
wajib
Possible values: user
steps.reviewers.id
string
wajib
steps.message
string
Payload respons
id
string
wajib
organizationId
string
workspaceId
string
ownerId
string
wajib
name
string
wajib
description
string
wajib
objectType
string
wajib
The identifier of the object
objectAction
string
wajib
The action performed on the object
Possible values: create, update, delete
steps
array of object
wajib
Tampilkan atribut turunan
steps.type
string
wajib
Possible values: any, all
steps.users
array of string
wajib
steps.reviewers
array of object
Tampilkan atribut turunan
steps.reviewers.type
string
wajib
Possible values: user
steps.reviewers.id
string
wajib
steps.message
string
createdAt
string
wajib
updatedAt
string
wajib
tags
array of object
Tampilkan atribut turunan
tags.key
string
wajib
tags.value
string
wajib
Contoh kode
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/approvals/{approvalId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'