Get a contact request

GET

https://v1.api.partnerpage.io/api/directory/private/v1alpha/contact-requests/:contactId/

GET

/api/directory/private/v1alpha/contact-requests/:contactId/

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

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "user@email.com",
  "companyName": "MyCompany",
  "href": "/api/directory/private/v1alpha/contact-requests/219a7d94-b934-4ccf-880f-d24b55e7e03e/",
  "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
  "created": "2024-08-23T13:40:00+00:00",
  "state": "pending",
  "projectStatus": "new",
  "entry": {
    "externalId": "0015g00000ABCDE",
    "id": "0f00e6b6-a7d4-4e2e-8bc5-273ddbc0d9c4",
    "owner": "2a5201d0-8b59-42b0-bda5-8aaf2c46c7bd",
    "title": "Entry Title"
  },
  "directory": {
    "customForm": {
      "answers": [
        {
          "answer": {
            "id": "3f2d1c0b-9a8b-4c7d-8e6f-5a4b3c2d1e0f",
            "systemKey": null,
            "value": "Germany"
          },
          "field": {
            "id": "9b0b0e1a-2b3c-4d5e-8f90-1a2b3c4d5e6f",
            "internalLabel": "hq-country",
            "label": "Country",
            "type": "single_option"
          },
          "otherText": null
        },
        {
          "answer": 1500,
          "field": {
            "currencyCode": "USD",
            "currencySymbol": "$",
            "decimals": 0,
            "id": "5c4b3a29-1817-4655-8443-2e1f0a9b8c7d",
            "internalLabel": null,
            "label": "MRR",
            "type": "currency"
          }
        },
        {
          "answer": "12.50",
          "field": {
            "id": "7e6d5c4b-3a29-4187-8655-4433221100ff",
            "internalLabel": null,
            "label": "Discount",
            "precision": 2,
            "type": "decimal"
          }
        }
      ],
      "groups": [
        {
          "description": null,
          "fields": [
            "9b0b0e1a-2b3c-4d5e-8f90-1a2b3c4d5e6f",
            "5c4b3a29-1817-4655-8443-2e1f0a9b8c7d",
            "7e6d5c4b-3a29-4187-8655-4433221100ff"
          ],
          "key": "step_1",
          "title": "About your company"
        }
      ]
    },
    "id": "12345678-1234-1234-1234-123456789abc",
    "name": "Directory Title",
    "orgId": "72887176-abc4-48d7-bdd6-35cf31aafb7e",
    "orgName": "Org name"
  },
  "source": "matchmaking",
  "matchOrigin": "string",
  "customForm": "string",
  "events": [
    {
      "type": "viewed",
      "timestamp": "2026-08-15T08:12:00Z",
      "data": {
        "actor": {
          "email": "sam@partner.example.com",
          "fullName": "Sam Partner",
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "role": "entry_owner"
        },
        "partnerName": "Entry Title"
      }
    },
    {
      "type": "reminder_sent",
      "timestamp": "2026-08-14T09:30:00Z",
      "data": {
        "created": "2026-08-14T09:30:00Z",
        "id": "5d1c7a0e-3b52-4a55-9d0e-6f1f0a4f3c21",
        "message": "Could you take a look this week?",
        "sender": {
          "email": "jane@example.com",
          "fullName": "Jane Doe",
          "id": "12",
          "role": "directory_owner"
        },
        "type": "reminder"
      }
    },
    {
      "type": "project_status_changed",
      "timestamp": "2026-08-13T10:00:00Z",
      "data": {
        "actor": {
          "email": "jane@example.com",
          "fullName": "Jane Doe",
          "id": "12",
          "role": "directory_owner"
        },
        "lostReason": "budget_or_timing",
        "lostReasonDetail": null,
        "previousProjectStatus": "engaged",
        "projectStatus": "lost"
      }
    }
  ],
  "firstViewedAt": "2026-08-15T08:12:00Z",
  "phone": null,
  "companyWebsite": "my-company.com",
  "comments": "Some comments",
  "utmQueryParams": {},
  "reminder": {
    "availableType": "reminder",
    "lastSent": {
      "id": "5d1c7a0e-3b52-4a55-9d0e-6f1f0a4f3c21",
      "type": "reminder",
      "message": "Could you take a look this week?",
      "created": "2026-08-14T09:30:00Z",
      "sender": {
        "id": "12",
        "fullName": "Jane Doe",
        "email": "jane@example.com",
        "role": "directory_owner"
      }
    },
    "partnerHasRecipients": true
  },
  "delivery": {
    "delivered": true,
    "heldAt": null,
    "releasedAt": null,
    "publicFormSubmittedAt": "2024-08-23T13:40:00.123456Z",
    "modified": "2026-08-15T08:12:00.654321Z"
  }
}

Retrieve details of a contact request for a directory owner organization

Authentication

AuthorizationToken

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

Path parameters

contactIdstringRequiredformat: "uuid"

ID of the contact requests to retrieve

Response

Detailed information about the contact request

firstNamestring<=50 characters

lastNamestring<=50 characters

emailstringformat: "email"

companyNamestring<=255 characters

hrefstringRead-only

idstringformat: "uuid"

createdstringRead-only

statestring

projectStatusenum or null

new - New
contacted - Contacted
engaged - Engaged
on_hold - On hold
secured - Secured
launched_deployed - Launched / Deployed
lost - Lost

entrymap from strings to any

directorymap from strings to any

sourceenum

matchmaking - Matchmaking
contact_request - Contact Request

Allowed values:

matchOriginstring or nullformat: "uuid"

customFormstringRead-only

eventslist of objects

firstViewedAtdatetime or null

phonestring or nullOptional<=30 characters

companyWebsitestring or nullOptional<=255 characters

commentsstring or nullOptional<=1000 characters

utmQueryParamsanyOptional

customFormResponseIdstringOptionalformat: "uuid"

declineReasonstring or nullOptional

declineReasonDetailstring or nullOptional

closeReasonstring or nullOptional

closeReasonDetailstring or nullOptional

routingSourcestring or nullOptional

isStalebooleanOptional

daysWaitingintegerOptional>=0

reminderCountintegerOptional>=0

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:

reminderobjectOptional

senderBlockedbooleanOptional

closeNotificationRecipientslist of stringsOptional

deliveryobjectOptional

Errors

403

Forbidden Error

404

Not Found Error