Skip to content
Hyperproof API
/
/
External Contacts API

External Contacts API (1.0)

Provides access to the external contacts that are part of a Hyperproof organization.

Download OpenAPI description
externalcontacts.openapi.json
externalcontacts.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi
Hyperproof US
https://api.hyperproof.app/v1/externalcontacts
Hyperproof EU
https://api.hyperproof.eu/v1/externalcontacts
Hyperproof Gov
https://api.hyperproofgov.app/v1/externalcontacts

Get External Contacts

Request

GET /

Description

Retrieves details of all external contacts by their unique IDs, returning information such as names, emails, and associated Hyperproof objects.

Security
oauth2
Query
objectTypestring

If provided, returns all external contacts associated with the objectType

Value"vendor"
objectIdstring

If provided, returns external contacts associated with the object. The objectType parameter is required if objectId is provided.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi/?objectType=vendor&objectId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring

The unique identifier for the external contact.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
givenNamestring

The given name of the external contact.

Example: "John"
surnamestring

The surname of the external contact.

Example: "Smith"
emailstring

The email address of the external contact.

Example: "john.smith@example.com"
objectTypestring

The type of the Hyperproof object the external contact is associated with.

Example: "vendor"
objectIdstring

The id of the Hyperproof object the external contact is associated with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
statusstring

The status of the external contact.

Enum"active""archived""deleted"
Example: "active"
createdOnstring(date-time)

The date the external contact was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
createdBystring

The unique identifier of the user who created the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date the external contact was updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring

The unique identifier of the user who last updated the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
permissionsArray of strings

List of permissions the API user has on the external contact.

Example: []
]
Response
application/json
[
  {
    "id": "d88d505d-5199-11ee-a644-522476618ae8",
    "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
    "givenName": "John",
    "surname": "Smith",
    "email": "john.smith@example.com",
    "status": "active",
    "objectType": "vendor",
    "objectId": "e99e616e-6211-22ff-b755-633587729bf9",
    "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "createdOn": "2023-09-12T18:26:10.0053650+00:00",
    "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "updatedOn": "2023-09-12T18:26:10.0053650+00:00",
    "permissions": []
  }
]

Add External Contact

Request

POST /

Description

Adds an external contact to a specified Hyperproof object, linking the contact’s details for collaboration or reference purposes.

Security
oauth2
Bodyapplication/json
givenNamestringrequired

The given name of the external contact.

Example: "John"
surnamestringrequired

The surname of the external contact.

Example: "Deer"
emailstringrequired

The email address of the external contact.

Example: "john.deer@example.com"
objectTypestringrequired

The type of the object to associate the external contact with.

Enum"vendor""risk"
Example: "vendor"
objectIdstringrequired

The unique identifier of the Hyperproof object to associate the external contact with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "givenName": "John",
    "surname": "Deer",
    "email": "john.deer@example.com",
    "objectType": "vendor",
    "objectId": "e99e616e-6211-22ff-b755-633587729bf9"
  }'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the external contact.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
givenNamestring

The given name of the external contact.

Example: "John"
surnamestring

The surname of the external contact.

Example: "Smith"
emailstring

The email address of the external contact.

Example: "john.smith@example.com"
objectTypestring

The type of the Hyperproof object the external contact is associated with.

Example: "vendor"
objectIdstring

The id of the Hyperproof object the external contact is associated with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
statusstring

The status of the external contact.

Enum"active""archived""deleted"
Example: "active"
createdOnstring(date-time)

The date the external contact was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
createdBystring

The unique identifier of the user who created the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date the external contact was updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring

The unique identifier of the user who last updated the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
permissionsArray of strings

List of permissions the API user has on the external contact.

Example: []
Response
application/json
{
  "id": "d88d505d-5199-11ee-a644-522476618ae8",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "givenName": "John",
  "surname": "Smith",
  "email": "john.smith@example.com",
  "status": "active",
  "objectType": "vendor",
  "objectId": "e99e616e-6211-22ff-b755-633587729bf9",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00",
  "permissions": []
}

Get External Contact

Request

GET /{externalContactId}

Description

Retrieves details of an external contact by their unique ID, returning information such as name, email, and associated Hyperproof objects.

Security
oauth2
Path
externalContactIdstringrequired

Unique ID of the external contact to retrieve.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi/{externalContactId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the external contact.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
givenNamestring

The given name of the external contact.

Example: "John"
surnamestring

The surname of the external contact.

Example: "Smith"
emailstring

The email address of the external contact.

Example: "john.smith@example.com"
objectTypestring

The type of the Hyperproof object the external contact is associated with.

Example: "vendor"
objectIdstring

The id of the Hyperproof object the external contact is associated with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
statusstring

The status of the external contact.

Enum"active""archived""deleted"
Example: "active"
createdOnstring(date-time)

The date the external contact was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
createdBystring

The unique identifier of the user who created the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date the external contact was updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring

The unique identifier of the user who last updated the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
permissionsArray of strings

List of permissions the API user has on the external contact.

Example: []
Response
application/json
{
  "id": "d88d505d-5199-11ee-a644-522476618ae8",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "givenName": "John",
  "surname": "Smith",
  "email": "john.smith@example.com",
  "status": "active",
  "objectType": "vendor",
  "objectId": "e99e616e-6211-22ff-b755-633587729bf9",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00",
  "permissions": []
}

Update External Contact

Request

PATCH /{externalContactId}

Description

Updates the information of an existing external contact, allowing modifications to details such as name, email, or associated Hyperproof objects.

Security
oauth2
Path
externalContactIdstringrequired

Unique ID of the external contact to update.

Bodyapplication/json
givenNamestring

The given name to update to for the external contact.

Example: "Jane"
surnamestring

The surname to update to for the external contact.

Example: "Doe"
emailstring

The email address to update to for the external contact.

Example: "jane.doe@example.com"
curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi/{externalContactId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "givenName": "Jane",
    "surname": "Doe",
    "email": "jane.doe@example.com"
  }'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the external contact.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
givenNamestring

The given name of the external contact.

Example: "John"
surnamestring

The surname of the external contact.

Example: "Smith"
emailstring

The email address of the external contact.

Example: "john.smith@example.com"
objectTypestring

The type of the Hyperproof object the external contact is associated with.

Example: "vendor"
objectIdstring

The id of the Hyperproof object the external contact is associated with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
statusstring

The status of the external contact.

Enum"active""archived""deleted"
Example: "active"
createdOnstring(date-time)

The date the external contact was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
createdBystring

The unique identifier of the user who created the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date the external contact was updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring

The unique identifier of the user who last updated the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
permissionsArray of strings

List of permissions the API user has on the external contact.

Example: []
Response
application/json
{
  "id": "d88d505d-5199-11ee-a644-522476618ae8",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "givenName": "John",
  "surname": "Smith",
  "email": "john.smith@example.com",
  "status": "active",
  "objectType": "vendor",
  "objectId": "e99e616e-6211-22ff-b755-633587729bf9",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00",
  "permissions": []
}

Delete External Contact

Request

DEL /{externalContactId}

Description

Removes an external contact from an organization.

Security
oauth2
Path
externalContactIdstringrequired

Unique ID of the external contact to delete.

curl -i -X DELETE \
  'https://developer.hyperproof.app/_mock/hyperproof-api/external-contacts/externalcontacts.openapi/{externalContactId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the external contact.

Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstring

The unique identifier for the organization.

Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
givenNamestring

The given name of the external contact.

Example: "John"
surnamestring

The surname of the external contact.

Example: "Smith"
emailstring

The email address of the external contact.

Example: "john.smith@example.com"
objectTypestring

The type of the Hyperproof object the external contact is associated with.

Example: "vendor"
objectIdstring

The id of the Hyperproof object the external contact is associated with.

Example: "e99e616e-6211-22ff-b755-633587729bf9"
statusstring

The status of the external contact.

Enum"active""archived""deleted"
Example: "active"
createdOnstring(date-time)

The date the external contact was created (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
createdBystring

The unique identifier of the user who created the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring(date-time)

The date the external contact was updated (ISO-8601 format).

Example: "2023-09-12T18:26:10.005365Z"
updatedBystring

The unique identifier of the user who last updated the external contact.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
permissionsArray of strings

List of permissions the API user has on the external contact.

Example: []
Response
application/json
{
  "id": "d88d505d-5199-11ee-a644-522476618ae8",
  "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
  "givenName": "John",
  "surname": "Smith",
  "email": "john.smith@example.com",
  "status": "active",
  "objectType": "vendor",
  "objectId": "e99e616e-6211-22ff-b755-633587729bf9",
  "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "createdOn": "2023-09-12T18:26:10.0053650+00:00",
  "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "updatedOn": "2023-09-12T18:26:10.0053650+00:00",
  "permissions": []
}
® 2026 Hyperproof All Rights Reserved.