{
"opencollection": "1.0.0",
"info": {
"name": "API Reference Accounts Contacts API",
"version": "0.0.0"
},
"items": [
{
"info": {
"name": "Contacts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get contact field definitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/contacts/definitions",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the schema for all field and relationship definitions available on contacts, including both system-defined and custom fields. Useful for understanding the shape of contact data before creating or updating records. See [Fields and relationships](/using-the-api/fields-and-relationships/) for more details.\n\n**[Required scope](/using-the-api/scopes/):** `contacts:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
},
{
"info": {
"name": "List contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/contacts",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a paginated list of contacts. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See [List endpoints](/using-the-api/list-endpoints/) for more information about [pagination](/using-the-api/list-endpoints/#pagination) and [filtering](/using-the-api/list-endpoints/#filtering).\n\n**[Required scope](/using-the-api/scopes/):** `contacts:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search"
},
{
"info": {
"name": "Create a contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/contacts",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a new contact record.\n\nAfter creation, Lightfield automatically enriches the contact in the background.\n\nSupports idempotency via the `Idempotency-Key` header.\n\nTo avoid duplicates, we recommend a find-or-create pattern — use [list filtering](/using-the-api/list-endpoints/#filtering) to check if a record exists before creating.\n\n**[Required scope](/using-the-api/scopes/):** `contacts:create`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write"
},
{
"info": {
"name": "Retrieve a contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/contacts/:id",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a single contact by its ID.\n\n**[Required scope](/using-the-api/scopes/):** `contacts:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
},
{
"info": {
"name": "Update a contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/contacts/:id",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates an existing contact by ID. Only included fields and relationships are modified.\n\nSupports idempotency via the `Idempotency-Key` header.\n\n**[Required scope](/using-the-api/scopes/):** `contacts:update`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write"
}
]
}
],
"bundled": true
}