Get Contact list or Search Contact

Shared APIs

Address Book APIs

Get Contact list or Search Contact

Request

This operation retrieves a list of contacts or searches for specific contacts based on the provided filters.

Security

bearerAuth

Query

skipinteger

The number of records to skip for pagination. Default is 0.

Example:skip=0

limitinteger

The maximum number of records to return. Default is 20.

Example:limit=20

sortstring

Specifies the sorting criteria for the returned list.
Use name:asc for ascending or name:desc for descending order based on the contact name.

Default:"name:asc"

searchBystring

Search contacts using default, name, company, email, otherNames, countryCode, street, city, state, postalCode, phone, uniqueID

Example:searchBy=name:John

filterBystring

Filter with order [begins ,contains, ends] on name, company fields and contactType ALL, SENDER, RECIPIENT.

Example:filterBy=name:begins&contactType:ALL

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/addressbookmgmt/api/v1/contact/search?skip=0&limit=20&sort=name%3Aasc&searchBy=name%3AJohn&filterBy=name%3Abegins%26contactType%3AALL' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The Contact list has been retrived successfully.

Bodyapplication/json

Array [

contactIdstring

The unique identifier for the contact searched.

Example:"6763e149671f04cace818d76"

personnelIDstring

A unique identifier for the contact. One personnelId can be associated with only one contact. If not set, the personnelId will default to null.

Example:"12RT345"

typestring

This is the type of contact:

S: Shared contact created at the subscription level and accessible to all users within the subscription.
U: Contact created at the user level and private to that user only.
Default is Subscription.

Enum:"S""U"

Example:"S"

contactTypestring

The type of contact to be created.

RECIPIENT: The contact is a recipient.
SENDER: The contact is a sender.
ALL: The contact can be both sender and recipient.

Enum:"RECIPIENT""SENDER""ALL"

Example:"RECIPIENT"

namestring

The name of the searched contact.

Example:"ContactTrans_101"

companystring

The company name associated with the searched contact.

Example:"Pitney Bowes"

addressesArray of objects

A list of address of the searched contact.

emailobject

The email detail of the searched contact.

additionalEmailIdsArray of strings

A list of additional email addresses of the searched contact.

Example:

[
  "test@pb.com"
]

phoneobject

The phone details of the searched contact.

customFieldsArray of objects

custom fields associated with the contact searched.

otherNamesArray of strings

A list of other names associated with the searched contact.

Example:

[
  "testotherNames1"
]

insertTimestampstring

The timestamp when the contact was created.

Example:"2024-12-19T09:03:05.072Z"

updateTimestampstring

The timestamp when the contact was last updated.

Example:"0001-01-01T00:00:00Z"

archivedboolean

If the contact is archived.

Example:false

createdBystring

The ID of the user who created the contact.

Example:"0oa27r9p8nfpRUqvv0h8"

updatedBystring

The ID of the user who last updated the contact.

Example:"0oa27r9p8nfpRUqvv0h8"

internalDeliveryobject

Internal package delivery preferences within the organization.

notificationobject

Notification preferences for the contact.

]

Response

[
  {
    "contactId": "6763e149671f04cace818d76",
    "personnelID": "12RT345",
    "type": "S",
    "contactType": "RECIPIENT",
    "name": "ContactTrans_101",
    "company": "Pitney Bowes",
    "addresses": [
      { … }
    ],
    "email": {
      "label": "Home",
      "email": "testuser@yopmail.com"
    },
    "additionalEmailIds": [
      "test@pb.com"
    ],
    "phone": {
      "label": "Home",
      "phone": "2037963184",
      "isdCode": "string"
    },
    "customFields": [
      { … }
    ],
    "otherNames": [
      "testotherNames1"
    ],
    "insertTimestamp": "2024-12-19T09:03:05.072Z",
    "updateTimestamp": "0001-01-01T00:00:00Z",
    "archived": false,
    "createdBy": "0oa27r9p8nfpRUqvv0h8",
    "updatedBy": "0oa27r9p8nfpRUqvv0h8",
    "internalDelivery": {
      "enabledInternalDelivery": true,
      "mailStopId": "4a0e2Bbshdh",
      "officeLocationId": "4a0e2Bb4Njw"
    },
    "notification": {
      "enabledEmailNotification": true,
      "enabledSMSNotification": false,
      "enabledAccessibilityAccommodations": false
    }
  }
]