Engagements

Engagements are configurations for your matching rounds. They contain all information on the matching criteria, email language and the timings of the Engagement.

Get Engagements

GET https://api.orbiit.ai/v0/workspaces/:workspaceId/engagements

Get all Engagements for a Workspace. You can optionally filter on the following query parameters

Query Parameters

Name
Type
Description

product

string (one-to-one, group)

Product type

statuses

string (DRAFT, SCHEDULED, OPTINSOPEN, MATCHING)

The status of the Engagement

Response

```json
{
    "totalCount": 1,
    "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false,
        "startCursor": "eyJpZCI6IjY2N2MwOTg0MWJmZjY1MDA1ZDAxZDA1MSIsInNvcnQiOnsiZmllbGQiOiJfY3JlYXRlZF9hdCIsInZhbHVlIjoiMjAyNC0wNi0yNlQxMjoyODo1Mi43NjRaIn19",
        "endCursor": "eyJpZCI6IjY2N2MwOTg0MWJmZjY1MDA1ZDAxZDA1MSIsInNvcnQiOnsiZmllbGQiOiJfY3JlYXRlZF9hdCIsInZhbHVlIjoiMjAyNC0wNi0yNlQxMjoyODo1Mi43NjRaIn19"
    },
    "results": [
        {
            "id": "000000000000000000000001",
            "createdAt": "2024-06-26T12:28:52.764Z",
            "status": "MATCHED",
            "name": "Orbiit Matching Round #4",
            "title": "1:1 Connections through Orbiit",
            "description": "Welcome to the latest opportunity to connect, learn from and get inspired by a fellow Community in Orbiit member through a meaningful conversation.",
            "product": "one-to-one"
        }
    ]
}
```

Last updated