Skip to content

Contact - summary

GET
/api/v2{contact_uri}summary

Get a summary of a contact (person or organisation) from their uri

contact_uri
required

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string
Example
/example/person/6305f074683e800f3abe809e/

Successful operation

A standard error message

object
description

A human readable description of the error

string
error

A concise error message

string
type

A machine readable error type

string

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

Not found

An error occurred within sheepCRM, please report to support@sheepcrm.com