Get all contact requests

GET

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

GET

/api/directory/private/v1alpha/directories/:directoryId/contact-requests/

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

[
  {
    "href": "string",
    "id": "string",
    "companyName": "string",
    "created": "string",
    "state": "string",
    "projectStatus": "new",
    "entry": {},
    "directory": {},
    "source": "matchmaking",
    "count": 3,
    "next": "admin.dev.partnerpage.io/api/directory/private/v1alpha/directories/72887176-abc4-48d7-bdd6-35cf31aafb7e/contact-requests/",
    "previous": null,
    "results": [
      {
        "companyName": "test",
        "created": "2024-08-23T13:40:00+00:00",
        "directory": {
          "id": "12345678-1234-1234-1234-123456789abc",
          "name": "Test Directory",
          "orgId": "72887176-abc4-48d7-bdd6-35cf31aafb7e",
          "orgName": "Test org"
        },
        "entry": {
          "id": "0f00e6b6-a7d4-4e2e-8bc5-273ddbc0d9c4",
          "owner": "2a5201d0-8b59-42b0-bda5-8aaf2c46c7bd",
          "title": "Entry Test"
        },
        "href": "/api/directory/private/v1alpha/contact-requests/219a7d94-b934-4ccf-880f-d24b55e7e03e/",
        "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
        "state": "pending"
      },
      {
        "companyName": "test-2",
        "created": "2024-08-23T13:40:00+00:00",
        "directory": {
          "id": "12345678-1234-1234-1234-123456789abc",
          "name": "Test Directory",
          "orgId": "72887176-abc4-48d7-bdd6-35cf31aafb7e",
          "orgName": "Test org"
        },
        "entry": {
          "id": "0f00e6b6-a7d4-4e2e-8bc5-273ddbc0d9c4",
          "owner": "2a5201d0-8b59-42b0-bda5-8aaf2c46c7bd",
          "title": "Entry Test"
        },
        "href": "/api/directory/private/v1alpha/contact-requests/219a7d94-b934-4ccf-880f-d24b55e7e03e/",
        "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
        "state": "accepted"
      },
      {
        "companyName": "test-3",
        "created": "2024-08-23T13:40:00+00:00",
        "directory": {
          "id": "12345678-1234-1234-1234-123456789abc",
          "name": "Test Directory",
          "orgId": "72887176-abc4-48d7-bdd6-35cf31aafb7e",
          "orgName": "Test org"
        },
        "entry": {
          "id": "0f00e6b6-a7d4-4e2e-8bc5-273ddbc0d9c4",
          "owner": "2a5201d0-8b59-42b0-bda5-8aaf2c46c7bd",
          "title": "Entry Test"
        },
        "href": "/api/directory/private/v1alpha/contact-requests/219a7d94-b934-4ccf-880f-d24b55e7e03e/",
        "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
        "state": "declined"
      }
    ]
  }
]

Retrieve directory contact-request history, including deleted partners and matchmaking assignments. Newest first unless a supported sort is supplied (oldest first with stale=true); ties are broken by id.

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory containing the contact requests

Query parameters

created_fromdatetimeOptional

Inclusive creation start date (ISO 8601).

created_todatetimeOptional

Inclusive creation end date (ISO 8601); midnight includes the entire day.

deliveredbooleanOptional

Only requests that were delivered to a partner: leaves out held requests and requests closed while held, as the requests report does.

entry_idstringOptionalformat: "uuid"

Exact partner entry ID, including deleted partner history. Also supported by CSV export.

pageintegerOptional

Page number. CSV exports all matching rows when omitted.

page_sizeintegerOptional

Number of results per page.

project_statusstringOptional

Comma-separated project statuses to keep: new, contacted, engaged, on_hold, secured, launched_deployed, lost, or not_set for contact requests with no project status, an empty one, or a stored value that is not one of the listed statuses.

routing_sourcestringOptional

Exact routing source label to keep; repeat the parameter to keep several labels. An empty value keeps contact requests with no routing source.

searchstringOptional

Search partner, customer or directory name.

sortstringOptional

Sort by created, company_name, entry_title or directory_name; prefix with - for descending. Omitted or unsupported: newest first (oldest first with stale=true). Ties are broken by id, so pages are stable.

sourcestringOptional

Contact origin: contact_request or matchmaking. Omit to include both.

stalebooleanOptional

Only pending requests with no reminder or partner activity for 3 days. Defaults to oldest first unless a supported sort is supplied.

statestringOptional

Exact contact-request state: pending, accepted or declined.

Response

Paginated list of contact requests

hrefstringRead-only

idstringformat: "uuid"

companyNamestring<=255 characters

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:

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:

Errors

400

Bad Request Error

404

Not Found Error