Matches

Retrieve the Matches for your Workspace, Engagements or Members using this endpoint.

Some of the endpoints will support pagination.

Retrieve a list of Matches

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

This endpoint supports

pagination

.

Path Parameters

Name	Type	Description
workspaceId*	String

Query Parameters

Name	Type	Description
product	String	Product type. Options are 'one-to-one', 'group', 'top-n'.
engagementIds	String	Comma-separated string to filter on specific Engagements
memberIds	String	Comma-separated string to filter on specific Members

200: OK

// Sample response
{
  "totalCount": 13,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": false,
    "startCursor": "eyJpZCI6I...",
    "endCursor": "eyJpZCI6..."
  },
  "nodes": [
    {
      "id": "6a7832326c717a6830777637",
      "createdAt": "1999-12-26T14:19:47.000Z",
      "engagementId": "616433676e367039346f396f",
      "memberIds": [
        "74326a776f6267316c366362",
        "6f786a6e6f35716c786b386a"
      ],
      "optInFormIds": [
        "386331317462776872336f68",
        "357438317161696830347135",
      ],
      "product": "one-to-one",
      "calendarUrl": "https://..."
    }
  ]
}