Skip to main content
GET
/
field-mappings
List field mappings for a provider + resource type
curl --request GET \
  --url http://localhost:5001/api/v1/field-mappings \
  --header 'Authorization: <api-key>'
{
  "success": false,
  "statusCode": 400,
  "message": "Validation Errors.",
  "errors": {
    "email": "email should not be empty"
  },
  "timestamp": "2026-02-06T12:00:00.000Z",
  "path": "/api/v1/example"
}

Authorizations

​
Authorization
string
header
required

Enter your API key with the Bearer prefix — e.g. Bearer sk_live_xxx (production) or Bearer sk_test_xxx (sandbox)

Query Parameters

​
provider
string
required

Provider slug

Example:

"hubspot"

​
resourceType
string
required

Resource type

Example:

"contact"

​
apiVersion
string

API version

Example:

"v3"

Response

Field mappings retrieved