Search LinX Workflows

Search for LinX workflows based on filters such as the workflow ID and status, and the Customer’s first name, last name, email address, and phone number.

Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /v2/linx/workflows

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

string

Perform a full-text search on the workflow ID and the Customer’s first name, last name, email address, and phone number.

You can also use the status filter to limit the search results. If both full-text search and the status filter are used, they will be joined using AND.

status

string enum, values: ACTIVE, ARCHIVED, CANCELLED, COMPLETED, CREATED, DECLINED, EXPIRED

Workflow status.

templateId

string (UUID)

ID of the LinX template used to create the workflow.

page

integer (int32), default value: 1

Page number to return. Uses one-based indexing.

size

integer (int32)

Maximum number of results to return per page.

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

Request Body

None

Returns

Returns a paginated response with an array of LinX Workflow Summary objects.

SAMPLE RESPONSE

				
					[
  {
    "id": "b6c0d73e-bd7b-4447-a30f-971ecad5fa8b",
    "templateId": "eacdf965-e9d8-408f-9cdf-3c7902d26ea7",
    "templateVersionId": "81f0f547-679c-4059-a6d7-1060021518cf",
    "status": "ACTIVE",
    "title": "Send a rebate to John Doe",
    "expireAt": "2023-11-11T21:00:49.776302Z",
    "nextNotificationAt": "2023-11-10T21:00:49.776302Z",
    "phoneNumber": "+16471234567",
    "email": "john.doe@abc.com"
  },
  {...},
  {...}
]