Get timeline events for a credentialing workflow

ID of the credentialing workflow

End at document ID, for backward cursor-based pagination

Filter Criteria

The filter parameter must be URL encoded when sent. Filters are specified as JSON objects where each field can have one or more filter operations.

Filterable Fields

Core Timeline Event Fields

• id: Timeline event unique identifier (String)
• createdBy: User who created the timeline event (String)
• createdAt: Timeline event creation timestamp (Timestamp)
• updatedAt: Timeline event last update timestamp (Timestamp)

Supported Filter Operations

String Fields (eq, neq, in, nin, contains)

• eq: Exact match - {"field":{"eq":"value"}}
• neq: Not equal - {"field":{"neq":"value"}}
• in: Match any value in array - {"field":{"in":["value1","value2"]}}
• nin: Not match any value in array - {"field":{"nin":["value1","value2"]}}
• contains: Substring match - {"field":{"contains":"partial"}} (case-sensitive)

Timestamp Fields (eq, neq, gt, gte, lt, lte)

• eq: Exact match - {"field":{"eq":"2023-01-01T00:00:00Z"}}
• neq: Not equal - {"field":{"neq":"2023-01-01T00:00:00Z"}}
• gt: Greater than - {"field":{"gt":"2023-01-01T00:00:00Z"}}
• gte: Greater than or equal - {"field":{"gte":"2023-01-01T00:00:00Z"}}
• lt: Less than - {"field":{"lt":"2023-01-01T00:00:00Z"}}
• lte: Less than or equal - {"field":{"lte":"2023-01-01T00:00:00Z"}}

Filter Examples

Basic Filters (before URL encoding)

// Filter by id
{"id":{"eq":"123"}}

// Filter by creator
{"createdBy":{"eq":"user@example.com"}}

Timestamp Filters

// Timeline events created after a specific date
{"createdAt":{"gt":"2023-01-01T00:00:00Z"}}

// Timeline events created within a date range
{"createdAt":{"gte":"2023-01-01T00:00:00Z","lte":"2023-12-31T23:59:59Z"}}

// Timeline events updated in last 7 days
{"updatedAt":{"gte":"2023-01-15T00:00:00Z"}}

Advanced Filters

// Exclude specific creators
{"createdBy":{"nin":["user1@example.com","user2@example.com"]}}

// Search by creator email contains
{"createdBy":{"contains":"@example.com"}}

Combined Filters

// Filter by creator and date
{
  "createdBy":{"eq":"user@example.com"},
  "createdAt":{"gte":"2023-01-01T00:00:00Z"}
}

// Filter by creator and date range
{
  "createdBy":{"contains":"@example.com"},
  "createdAt":{"gte":"2023-01-01T00:00:00Z","lte":"2023-12-31T23:59:59Z"}
}

cURL Examples

# Filter by id
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?filter=%7B%22id%22%3A%7B%22eq%22%3A%22123%22%7D%7D'

# Filter by creator
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?filter=%7B%22createdBy%22%3A%7B%22eq%22%3A%22user%40example.com%22%7D%7D'

# Filter by creation date range
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?filter=%7B%22createdAt%22%3A%7B%22gte%22%3A%222023-01-01T00%3A00%3A00Z%22%2C%22lte%22%3A%222023-12-31T23%3A59%3A59Z%22%7D%7D'

# Combined filter: creator and date
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?filter=%7B%22createdBy%22%3A%7B%22contains%22%3A%22%40example.com%22%7D%2C%22createdAt%22%3A%7B%22gte%22%3A%222023-01-01T00%3A00%3A00Z%22%7D%7D'

Note: Always URL encode the JSON filter string before sending the request.

Sorting/Ordering

Sort results by specifying a field name and direction. The order parameter must be URL encoded when sent.

Sortable Fields

You can sort by any of the following fields:

• id: Timeline event unique identifier
• createdBy: User who created the timeline event (sortable and filterable)
• createdAt: Timeline event creation timestamp
• updatedAt: Timeline event last update timestamp
• updatedBy: User who last updated the timeline event (sortable only, not filterable)
• data: JSON data field (lexicographic ordering)

Sort Direction

• ASC: Ascending order (default)
• DESC: Descending order

Note: Sort direction is case-insensitive, but uppercase is recommended (ASC/DESC).

Sort Format

{
  "orderBy": "fieldName",
  "orderByDirection": "ASC|DESC"
}

Sort Examples

Basic Sorting (before URL encoding)

// Sort by creation date (oldest first)
{"orderBy":"createdAt","orderByDirection":"ASC"}

// Sort by creation date (newest first)
{"orderBy":"createdAt","orderByDirection":"DESC"}

// Sort by id (ascending)
{"orderBy":"id","orderByDirection":"ASC"}

// Sort by creator (ascending)
{"orderBy":"createdBy","orderByDirection":"ASC"}

// Sort by last update (newest first)
{"orderBy":"updatedAt","orderByDirection":"DESC"}

cURL Examples

# Sort by creation date (newest first)
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?order=%7B%22orderBy%22%3A%22createdAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'

# Sort by id (descending)
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?order=%7B%22orderBy%22%3A%22id%22%2C%22orderByDirection%22%3A%22DESC%22%7D'

# Sort by creator (ascending)
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?order=%7B%22orderBy%22%3A%22createdBy%22%2C%22orderByDirection%22%3A%22ASC%22%7D'

# Combine filter and sort: Get timeline events filtered by creator, sorted by date
curl -X GET 'http://localhost:8080/credentialing-workflows/{workflowId}/timeline-events?filter=%7B%22createdBy%22%3A%7B%22contains%22%3A%22%40example.com%22%7D%7D&order=%7B%22orderBy%22%3A%22createdAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'

Note: Always URL encode the JSON order string before sending the request.

Page number (0-based), for offset-based pagination

Page size

Start after document ID, for forward cursor-based pagination

Tenant ID