API Reference

Stocklist & project endpoints

Get your stocklist

http

GET /stocklist

Returns a paginated list of projects available on your DashCRM stocklist.

Filtering options

page - Page number (default: 1)

limit - Results per page (default: 20, max: 100)

region - Filter by region

city - Filter by city

suburb - Filter by suburb

status - Filter by project status

updated_since - Only return projects updated after this ISO 8601 timestamp (for example 2026-04-10T00:00:00.000Z)

Example request

bash

curl "https://app.dashcrm.co/api/v1/stocklist?page=1&limit=20&region=auckland" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

json

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "filters": {
    "region": "auckland",
    "city": null,
    "suburb": null,
    "status": null,
    "updatedSince": null
  },
  "organization": {
    "id": "account_123",
    "companyName": "Example Developments",
    "displayName": "Example Developments",
    "intro": null,
    "email": "sales@example.com",
    "phone": null,
    "location": "Auckland",
    "websiteUrl": "https://example.com",
    "logoImage": {
      "key": "accounts/logo/example.png",
      "url": "https://..."
    }
  },
  "projects": [
    {
      "id": "project_123",
      "slug": "te-mara",
      "name": "Te Mara",
      "status": "Available",
      "addressLine1": "12 Example Street",
      "addressLine2": null,
      "postalCode": "1010",
      "latitude": -36.8485,
      "longitude": 174.7633,
      "updatedAt": "2026-04-10T10:00:00.000Z",
      "cityName": "Auckland",
      "regionName": "Auckland",
      "regionSlug": "auckland",
      "suburbName": "Grey Lynn",
      "heroImage": null,
      "galleryImages": [],
      "unitCount": 12,
      "availableUnitCount": 5,
      "units": []
    }
  ]
}

Get a single project

http

GET /projects/:slug

Returns the full details for a single project. Use the project's slug (from the stocklist response) as the URL parameter.

Example request

bash

curl "https://app.dashcrm.co/api/v1/projects/te-mara" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

json

{
  "organization": {
    "id": "account_123",
    "companyName": "Example Developments",
    "displayName": "Example Developments",
    "intro": null,
    "email": "sales@example.com",
    "phone": null,
    "location": "Auckland",
    "websiteUrl": "https://example.com",
    "logoImage": null
  },
  "project": {
    "id": "project_123",
    "slug": "te-mara",
    "name": "Te Mara",
    "status": "Available",
    "developmentDescription": "A townhouse community in Auckland.",
    "estimatedCompletionDate": "2026-12-01T00:00:00.000Z",
    "addressLine1": "12 Example Street",
    "addressLine2": null,
    "postalCode": "1010",
    "cityName": "Auckland",
    "regionName": "Auckland",
    "regionSlug": "auckland",
    "suburbName": "Grey Lynn",
    "projectWebsiteUrl": "https://example.com/te-mara",
    "heroImage": null,
    "galleryImages": [],
    "relatedProjects": [],
    "units": []
  }
}

← Previous

Getting started

Import a contact