Contact

Endpoints relating to Contact objects

List contact objects

Returns a list of contacts in the network.

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive)

Example: per=20
f.company_ref
string

The ref for the company.

f.company.id
string

The id for the company.

f.location.id
string

Filters out all contacts not related to this location.

Responses
200

collection of contacts

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
total_count
integer
Array of objects (Contact)
get/network/contacts
Response samples
application/json

Success

{}

Create a new contact object

Request
Request Body schema: application/json
name
required
string

Always required. Name of the new contact.

email
required
string

Always required. Email address of the new contact.

phone_number
required
string

Always required. Phone number of the new contact.

company_id
string

ID of the new contact's company. If not specified, the contact will be created for your company.

Responses
200

The created contact

Response Schema: application/json
_object
string
self
string
version
integer
object (Contact)
_object
string

Type of the object. Always /network/contact for this object.

id
string <string>

Unique identifier for the contact

name
string
email
string
phone_number
string
object (GenericCollectionRef)
object
post/network/contacts
Request samples
application/json
{
  • "name": "John Smith",
  • "email": "john@example.com",
  • "phone_number": "861-555-5555",
  • "company_id": "2UXaj4xcHoW8nwh9UVOMpw"
}
Response samples
application/json

Success

{}

Retrieve a contact

Retrieves the details of a single contact.

Request
path Parameters
id
required
string

The unique id for the requested contact

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (Contact)
_object
string

Type of the object. Always /network/contact for this object.

id
string <string>

Unique identifier for the contact

name
string
email
string
phone_number
string
object (GenericCollectionRef)
object
get/network/contacts/{id}
Response samples
application/json

Success

{}

Update an existing contact

Request
path Parameters
id
required
string

The unique id for the requested contact

Example: FHLKEFHHoW8nwh9UVOMpw
Request Body schema: application/json
name
string

Updated name of the contact.

email
string

Updated email address of the contact.

phone_number
string

Updated phone number of the contact.

Responses
200

The updated contact

Response Schema: application/json
_object
string
self
string
version
integer
object (Contact)
_object
string

Type of the object. Always /network/contact for this object.

id
string <string>

Unique identifier for the contact

name
string
email
string
phone_number
string
object (GenericCollectionRef)
object
patch/network/contacts/{id}
Request samples
application/json
{
  • "name": "John Smith",
  • "email": "john_new_email@example.com",
  • "phone_number": "861-555-7777"
}
Response samples
application/json

Success

{}