Skip to main content
POST
/
api
/
applications
/
list
List applications with pagination
curl --request POST \
  --url https://your-instance.example.com/api/applications/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "size": 25,
  "search": "maple court",
  "pipelineStage": "Tour scheduled"
}
'
{
  "success": true,
  "total": 142,
  "page": 1,
  "size": 10,
  "data": [
    {
      "_id": "64d2f9c5e8a1d4e001a0b1c2",
      "name": "Maple Court — Unit 412",
      "status": "in_progress",
      "pipelineStage": "Tour scheduled"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:10
Required range: x >= 1
​
search
string
​
contactId
string
​
status
string
​
userId
string
​
pipelineStage
string
​
pipelineStageIds
string

JSON array string or single id string.

Response

Applications returned

Paginated list response for POST /api/applications/list.

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
total
integer
required

Total matching applications across all pages.

​
page
integer
required
​
size
integer
required