Contact

Get Contacts

You can create contacts for anyone you need to keep in touch with, such as your clients, suppliers, staff, or even resources.

Contacts help you store and organize important details like phone numbers, email addresses, and other contact information, making it easy to manage communication across your projects.

READ access to the CONTACT module is required to access this endpoint

Unlike virtually every other model, contact id cannot be assumed to be unique. Use uuid instead.

Contacts may be either people or organizations and these are stored in separate tables in the database, each with its own auto-incrementing identifier.

The contacts model creates a union between these two tables to allow simplified operations under a single namespace.

GET

contact

curl --request GET \
  --url https://api.sonderplan.com/v2/contact \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 89420384,
      "uuid": "p89420384",
      "name": "Sam Smith",
      "type": "person",
      "linked_organization_id": 137834,
      "linked_resource_id": 237449,
      "client": true,
      "user": true,
      "resource": true,
      "email_1": "[email protected]",
      "email_2": "[email protected]",
      "email_3": "",
      "phone_1": "+1-541-754-3010",
      "phone_2": "",
      "phone_3": "",
      "address_line_1": "Unit 1/43",
      "address_line_2": "123 Example Street",
      "address_line_3": "",
      "address_city": "Surry Hills",
      "address_state": "NSW",
      "address_postcode": "2010",
      "address_country": "Australia",
      "website": "www.example.com",
      "icon": {},
      "custom_fields": [
        {
          "id": 7823,
          "name": "Type",
          "value": "Video Editing",
          "value_id": 8973,
          "update_key": "2_1_7823"
        }
      ],
      "created_id": 3,
      "created": 1388552400,
      "created_name": "John Smith",
      "updated_id": 3,
      "updated": 1388552400,
      "updated_name": "John Smith"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

One or more (comma seperated) IDs of contacts to retrieve. Warning, use uuid to guarantee a single result is returned

uuid

string

One or more (comma seperated) uuids of contacts to retrieve

name

string

Perform a partial match text search for the contact name

type

enum<string>

Specify the type of contact you wish to return

Available options:

person,

organization

updated_after

integer

Return results that were added, edited or deleted since this UNIX timestamp

fields

string

Comma seperated list of fields you wish to return

page

integer

Specify the page of results you wish to return

limit

integer

The number of results returned per page. Default if not specified is 10

order_asc

string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

order_desc

string

Specify the field (with type of string or integer) you wish to order (descending) the response with

filter_operator

enum<string>

default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:

OR,

AND

Response

200

application/json

Successful Operation

data

object[]

The default contact schema

data.id

integer

Non unique, automatically generated contact identifier

Example:

89420384

data.uuid

string

Unique automatically generated contact universally unique identifier

Example:

"p89420384"

data.name

string

Full name of the contact

Example:

"Sam Smith"

data.type

enum<string>

Type of the contact

Available options:

person,

organization

Example:

"person"

data.linked_organization_id

integer

The organization id that this contact has been added to. Applies only for 'person' type contacts.

Example:

137834

data.linked_resource_id

integer

The resource id that this contact has been added to. Applies only for 'person' type contacts.

Example:

237449

data.client

boolean

If true, the contact will be selectable in client menus

Example:

true

data.user

boolean

If true, the contact is linked to a user. Hidden by default

Example:

true

data.resource

boolean

If true, the contact is linked to a resource. Hidden by default

Example:

true

data.email_1

string

Primary email address of the contact

Example:

"[email protected]"

data.email_2

string

Secondary email address of the contact

Example:

"[email protected]"

data.email_3

string

Tertiary email address of the contact

Example:

""

data.phone_1

string

Primary phone number of the contact

Example:

"+1-541-754-3010"

data.phone_2

string

Secondary phone number of the contact

Example:

""

data.phone_3

string

Tertiary phone number of the contact

Example:

""

data.address_line_1

string

Contacts address first line

Example:

"Unit 1/43"

data.address_line_2

string

Contacts address second line

Example:

"123 Example Street"

data.address_line_3

string

Contacts address third line

Example:

""

data.address_city

string

Contacts city

Example:

"Surry Hills"

data.address_state

string

Contacts state

Example:

"NSW"

data.address_postcode

string

Contacts state

Example:

"2010"

data.address_country

string

Contacts country

Example:

"Australia"

data.website

string

Website of the contact

Example:

"www.example.com"

data.icon

object

Icon / avatar of the contact

data.custom_fields

object[]

Used to show the values of custom fields on linked modules

data.created_id

integer

The unique ID of the person (user) who created this record

Example:

3

data.created

integer

The UNIX time value of the creation time

Example:

1388552400

data.created_name

string

The full name of the person (user) who created this record

Example:

"John Smith"

data.updated_id

integer

The unique ID of the person (user) who last updated this record

Example:

3

data.updated

integer

The UNIX time value of the last update

Example:

1388552400

data.updated_name

string

The full name of the person (user) who last updated this record

Example:

"John Smith"

Instance

Billable Item

Booking

Calendar Subscription

Contact

Custom Field

Group

Invoice

Quote

Invoice Template

User

Project

Rate Scheme

Resource

Workspace

Status

Tax

Time Activity

Time Entry

Get Contacts

Authorizations

Query Parameters

Response