Retrieve Workflow Configurations

Request

Retrieve the Workflow Configurations. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item

Security

api_key

Query

namestring

Filter for the name of the Workflow

enabledboolean

Filter for Workflows based on their enabled status

validatedboolean

Filter for Workflows based on their validation status

afterstring

Cursor for pagination. Indicates that the API should return the Workflows which are immediately after this one in the list (the next page)

maxItemsnumber, [ 1 .. 1000 ]

Maximum number (1 - 1000) of Workflows that might be returned. It is possible that the response contains fewer elements. Default to 100

Default:100

x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/workflows?name=string&enabled=true&validated=true&after=string&maxItems=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Successful response with a paginated list of Workflow Configurations

Bodyapplication/json

itemsArray of objects(WorkflowResponseDto)required

Array of items for the current page

totalItemsnumberrequired

Total number of items available (without pagination)

Response

{
  "items": [
    { … }
  ],
  "totalItems": 0
}