Opt-In Forms

Opt-In Forms represent the entry of a given Member to the matching round (i.e., Engagement). It holds the data they provided that will be used in the matching.

Some of the endpoints will support pagination.

Retrieve a list of Opt-In Forms

GET https://api.orbiit.ai/v0/workspaces/:workspaceId/optin-forms

This endpoint supports pagination

.

Path Parameters

Name	Type	Description
workspaceId*	String

Query Parameters

Name	Type	Description
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": 310,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": false,
    "startCursor": "eyJpZCI6I...",
    "endCursor": "eyJpZCI6..."
  },
  "results": [
    {
      "id": "fd55adacab3585e3e41d1337",
      "createdAt": "2023-08-08T16:05:45.512Z",
      "engagementId": "fe2799c58cbdcded8b4538f7",
      "memberId": "366a3738626b656c67726775",
      "fields": {
        "email": "[email protected]",
        "firstName": "Timmy",
        "lastName": "Dev",
      }
    },
  ],
}