Difference between revisions of "API:People:Get"

From docs
Jump to: navigation, search
(Created page with "== API » Get People == '''URL:''' <nowiki>https://app.callproof.com/api/contact/personnel/get/</nowiki> '''Method:''' GET '''Required Fields:''' * '''''key''''' -...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
== [[API]] &#187; Get People ==
 
== [[API]] &#187; Get People ==
  
'''URL:''' <nowiki>https://app.callproof.com/api/contact/personnel/get/</nowiki>
+
'''URL:''' <nowiki>https://app.callproof.com/api/contact/personnel/get/<contact_id>/</nowiki>
  
 
'''Method:''' GET
 
'''Method:''' GET
Line 9: Line 9:
 
* '''''key''''' - API Key
 
* '''''key''''' - API Key
 
* '''''secret''''' - API Key Secret
 
* '''''secret''''' - API Key Secret
* '''''id''''' - Contact ID
 
  
 
'''Optional Fields:'''
 
'''Optional Fields:'''
Line 17: Line 16:
 
'''Data Returned:'''
 
'''Data Returned:'''
  
* '''''results''''' - Contact Notes
+
* '''''results''''' - People records
 
* '''''errors''''' - Array of errors produced by the request
 
* '''''errors''''' - Array of errors produced by the request
 
* '''''code''''' - HTTP request status
 
* '''''code''''' - HTTP request status

Latest revision as of 09:33, 24 May 2019

API » Get People

URL: https://app.callproof.com/api/contact/personnel/get/<contact_id>/

Method: GET

Required Fields:

  • key - API Key
  • secret - API Key Secret

Optional Fields:

None

Data Returned:

  • results - People records
  • errors - Array of errors produced by the request
  • code - HTTP request status