Data API

The Data API provides read-only access to Parcel’s four market datasets: accounts, contacts, projects, and signals. Use it to search records, retrieve a single record by id, fetch related records, and check credit usage.

Base URL

Base URL

https://api.parcelengineering.com/api/v1

Authentication

All requests require a bearer token:

Authorization header

Authorization: Bearer pcl_your_api_key

AuthenticationHow to create a workspace API key and keep it secure.

Endpoints

Method	Path	Description
POST	/data/{dataset}/search	Search a dataset
GET	/data/{dataset}/{id}	Fetch one record by UUID
GET	/data/usage	Credit usage for the trailing 24 hours

{dataset} is one of accounts, contacts, projects, or signals.

Response envelope

Every response wraps its payload in a consistent envelope:

Search response

{
  "data": [ { "id": "8a1f...", "name": "..." } ],
  "metadata": {
    "total": 142,
    "total_is_capped": false,
    "credits": 25
  }
}

Get-by-id response

{
  "data": { "id": "8a1f...", "name": "..." },
  "metadata": { "credits": 1 }
}

• data: the record or array of records.
• metadata.total: match count capped at 1,000. When total_is_capped is true, more than 1,000 records match and the true count is unknown.
• metadata.credits: credits consumed by this request. GET /data/usage always returns 0 here.

Note

The Data API requires the Pro plan. Free and Starter workspaces receive a 403. Each record returned costs 1 credit, up to a ceiling of 250,000 credits per rolling 24 hours. See the Enums and Patterns pages for error codes and pagination details.

Explore the reference

DatasetsFields, filters, and sort keys for accounts, contacts, projects, and signals.SearchPOST search, GET by id, and GET related records.PatternsFiltering grammar, pagination, and error handling.EnumsAllowed values for stage, disposition, signal type, and more.