Skip to main content
GET
/
v2
/
contact
Get Contacts
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

​
id
string<string>

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

​
uuid
string<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

Successful Operation

​
data
Contact Model · object[]
​
meta
object