Skip to content
English
  • There are no suggestions because the search field is empty.

PSOhub API - Contacts

Learn about searching and creating new contacts in PSOhub via API

In PSOhub, contacts are the people that are part of a company and can be linked to a project, be an invoice contact or become a stakeholder. You are able to find contacts based on search criteria and create new contacts

Get all contacts

To get all contacts, you can use the following endpoint

GET https://www.psohubapp.com/rest/psohubapi/v1/contacts

You can use the limit parameter to determine the number of records to return. If you don't send this, we will send back 50 contacts.

If successful, the response will be this

[{
"Email": "michael@qweb.com",
"ContactID": 21110623253302801,
"CompanyID": 14073748839680461,
"CompanyName": "Qweb",
"FirstName": "Michael",
"LastName": "Qweb",
"Salutation": "Mr",
"JobTitle": "Designer",
"Phonenumber": "3169482932"
}]

Find a contact

If you need to find a specific contact you can use the parameters below to find all contacts that contain a certain word like in the example below

GET https://www.psohubapp.com/rest/psohubapi/v1/contacts?email=peterbosman@rtl4.nl

If found, the response will return all records where the email matches peterbosman@rtl4.nl

The following search parameters can be used (all lower case)

 

Name

Type

Description

name

string

The name of the contact

email

string

the email of the contact

companyid

integer/long

the PSOHub ID of the company

contactid

integer/long

The PSOhub ID of the contact

companyname

string

the name of the company

 

Create/Update a contact

You can create new contacts in PSOHub. To do this, please use the following endpoint

POST/PATCH https://www.psohubapp.com/rest/psohubapi/v1/contact

The following fields are available , the mandatory fields are marked as such.

IMPORTANT: We do not have a check on unique email or name. You can have multiple contacts with the same email within your organization. Make sure a contact really does not exist before creating it.

Name

Required

Type

Description

FirstName

No

String

The first name of the contact

LastName

Yes

String

The last name of the contact

Email

Yes

String

the email of the contact

Salutation

No

String

Title like Mr/Ms

Phonenumber

No

String

Phonenumber where the contact can be reached

JobTitle

No

String

The known job title

CompanyID

Yes

Integer/long

the PSOHub ID of the company

ContactID

Yes(only for update)

Integer/long

The PSOhub ID of the contact

ExternalID

No

String

The identifier from your application for this contact

A valid request will look like this

{
"FirstName": "Mike",
"LastName": "Dovers",
"Email": "mikedovers@tech.corp",
"CompanyID": "14073748840908986",
"ExternalID: "26343"
}

Upon success, you will in return get the ContactID

{
"ContactID": "21110623259110549"
}