List all contacts

You can retrieve your contacts through the API.

List all contacts

GET https://api.treevox.com/v1/contacts

Returns a list of your contacts. The contacts are returned sorted by creation date, with the most recently created contacts appearing first.

Query Parameters

Name	Type	Description
offset	Number	A cursor for use in pagination. offset is an number that defines your place in the list. For instance, if you make a list request and receive 100 objects, your subsequent call can include offset = 100 in order to fetch the next page of the list. (Default is 0)
limit	Number	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
classification	Number	Only return contacts with the given classification. classification is a number from 1 to 5
created	Date	A filter on the list based on the object createdAt field. The value can be a string with Date.
created.gt	Date	Return results where the createdAt field is greater than this value.
created.gte	Date	Return results where the createdAt field is greater than or equal to this value.
created.lt	Date	Return results where the createdAt field is less than this value.
created.lte	Date	Return results where the createdAt field is less than or equal to this value.
assignedToId	Number	Only return contacts with the given assignedToId. assignedToId would be the identifier of the contact owner.
ids	String	Only return contacts with the given IDs. ids would be the contact's id, it is sent separated by ,(1,2,3,4,5)
expand[]	String	values: organization, country, stage, assignedTo, userCreator. Doc expandable

Headers

Name	Type	Description
Content-Type*	application/json
Accept-Encoding	gzip
x-api-key*	String	your api key in treevox

200: OK A dictionary with a data property that contains an array of up to limit contacts, starting after contact offset. Each entry in the array is a separate contact object. If no more contacts are available, the resulting array will be empty. This request should never return an error.

{
  "data": [
    {
      "id": "1",
      "name": "Zelma",
      "surname": "Pacocha",
      "dni": "885838866",
      "jobTitle": "Investor Infrastructure Officer",
      "email": "[email protected]",
      "secondaryEmail": "[email protected]",
      "phone": "218-224-9677",
      "mobilePhone": "1-597-960-1880",
      "urlAvatar": "http://placeimg.com/640/480",
      "address": "Sharon Via",
      "withSales": false,
      "city": "East Sylvester",
      "countryId": 31,
      "classification": 74,
      "stageId": 17,
      "organizationId": 65,
      "assignedToId": 59,
      "userCreatorId": 33,
      "createdAt": "2021-06-16T14:20:59.553Z",
      "updatedAt": "2021-11-26T04:39:51.894Z"
    }
  ],
  "pagination": {
    "total": 0,
    "offset": 10,
    "limit": 3,
    "totalPage": "10"
  }
}

400: Bad Request

{
    "timestamp": "2021-11-25T03:45:20.986Z",
    "message": "Validation failed",
    "code": "bad_request",
    "errors": [
        {
            "property": "created",
            "validator": {
                "isDateString": "created must be a valid ISO 8601 date string"
            }
        }
    ]
}