List all business

You can retrieve your business through the API.

List all bisiness

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

Returns a list of your business. The business are returned sorted by creation date, with the most recently created business 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.

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.

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

{
  "data": [
    {
      "id": 1,
      "title": "New Website Project",
      "value": 15000,
      "deadline": "2025-12-31T23:59:59.000Z",
      "private": false,
      "position": 1,
      "dateWon": "2025-03-20T15:30:00.000Z",
      "reasonLost": null,
      "statusId": 2,
      "organizationId": 45,
      "currencyId": 1,
      "userOwnerId": 12,
      "userCreatorId": 8,
      "boardId": 3,
      "stageId": 7,
      "createdAt": "2025-01-10T10:15:30.000Z",
      "updatedAt": "2025-09-10T12:45:00.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 0,
    "limit": 10,
    "totalPage": 1
  }
}

Última actualización

¿Te fue útil?