Get a matchmaking request

GET

https://v1.api.partnerpage.io/api/directory/private/v1alpha/matchmaking-requests/:matchmakingId/

GET

/api/directory/private/v1alpha/matchmaking-requests/:matchmakingId/

curl https://v1.api.partnerpage.io/api/directory/private/v1alpha/matchmaking-requests/matchmakingId/ \
     -H "Authorization: Token  <apiKey>"

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "companyName": "MyCompany",
  "owner": "string",
  "href": "/api/directory/private/v1alpha/matchmaking-requests/219a7d94-b934-4ccf-880f-d24b55e7e03e/",
  "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
  "created": "2025-03-22T15:00:00+00:00",
  "state": "closed",
  "assignedPartners": "string",
  "dateAssigned": "string",
  "ownerName": "string",
  "customForm": "string",
  "stateHistory": [
    {
      "changedAt": "2025-03-23T09:30:00+00:00",
      "changedBy": {
        "fullName": "Jane Doe",
        "id": "5f0c2a3e-6b1d-4c8e-9a7f-2d3b4c5e6f70"
      },
      "closeReason": "no_suitable_partner",
      "closeReasonDetail": null,
      "state": "closed"
    }
  ],
  "senderBlocked": true,
  "delivery": {
    "delivered": true,
    "heldAt": null,
    "releasedAt": null,
    "publicFormSubmittedAt": "2025-03-22T15:00:00.123456Z",
    "modified": "2025-03-23T09:30:00.654321Z"
  },
  "partnerAssignments": [
    {
      "id": "4b7e2c1d-9f3a-4e8b-a6d5-0c1f2e3d4a5b",
      "state": "declined",
      "created": "2025-03-22T16:00:00.123456Z",
      "modified": "2025-03-23T09:00:00.654321Z",
      "delivered": true,
      "heldAt": null,
      "releasedAt": null,
      "partner": {
        "id": "0f00e6b6-a7d4-4e2e-8bc5-273ddbc0d9c4",
        "title": "Entry Title",
        "externalId": "0015g00000ABCDE",
        "isDeleted": false
      }
    }
  ],
  "closeReason": "no_suitable_partner",
  "closeReasonDetail": null,
  "holdReason": null
}

Retrieve details of a matchmaking request. stateHistory lists its state changes newest first, limited to the 20 most recent. delivery gives the request’s hold, release and public form submission times. partnerAssignments lists every linked partner contact request, newest first, and is null if any of them points to a partner outside the request’s directory.

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

matchmakingIdstringRequiredformat: "uuid"

ID of the matchmaking request

Response

Detailed matchmaking request

firstNamestring<=50 characters

lastNamestring<=50 characters

emailstringformat: "email"

companyNamestring<=255 characters

ownerstring

hrefstringRead-only

idstringformat: "uuid"

createdstringRead-only

statestring

assignedPartnersstringRead-only

dateAssignedstringRead-only

ownerNamestringRead-only

customFormstringRead-only

stateHistorylist of maps from strings to anyRead-only

senderBlockedboolean

deliveryobject

partnerAssignmentslist of objects or null

phonestring or nullOptional<=30 characters

companyWebsitestring or nullOptional<=255 characters

commentsstring or nullOptional<=1000 characters

utmQueryParamsanyOptional

closeReasonstring or nullOptional

closeReasonDetailstring or nullOptional

holdReasonenum or nullOptional

same_message - Same message already sent to 2 partners today
same_phone - Same phone number already sent to 2 partners today
same_company - Same company already sent to 2 partners today

Allowed values:

customFormResponseIdstringOptionalformat: "uuid"

Errors

403

Forbidden Error

404

Not Found Error