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
Possible values: <= 500
Example: 10
skip number
Example: 0

Responses

200

successful operation

application/json

Schema

Schema

result

contactdetails[]

Array [

objectId string

name string

email string

phone string

createdAt date

updatedAt date

]

Example (from schema)

{
  "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"
    }
  ]
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...