Get contact list
+Help use spread the word - ⭐ OpenSign on GitHub
Get contact list
GET+/contactlist
The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.
Request
Query Parameters
limit number
Example: 10
skip number
Example: 0
Header Parameters
x-api-token stringrequired
Example: opensign.xxxx
Responses
- 200
- 405
successful operation
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
result
contactdetails[]
objectId string
Name string
Email string
Phone string
createdAt date
updatedAt date
{
"result": [
{
"objectId": "ph1bhx2jp",
"Name": "joe bee",
"Email": "joebee@example.com",
"Phone": "4131231231",
"createdAt": "2023-10-07T16:49:56.000Z",
"updatedAt": "2023-10-07T16:49:56.000Z"
}
]
}
Invalid API Token!
- application/json
- Schema
- Example (from schema)
Schema
error string
{
"error": "Invalid API token!"
}
Loading...
Responses
- 200
- 405
successful operation
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
result
contactdetails[]
objectId string
Name string
Email string
Phone string
createdAt date
updatedAt date
{
"result": [
{
"objectId": "ph1bhx2jp",
"Name": "joe bee",
"Email": "joebee@example.com",
"Phone": "4131231231",
"createdAt": "2023-10-07T16:49:56.000Z",
"updatedAt": "2023-10-07T16:49:56.000Z"
}
]
}
Invalid API Token!
- application/json
- Schema
- Example (from schema)
Schema
error string
{
"error": "Invalid API token!"
}
Loading...