Get Contacts

curl --request GET \
  --url https://api.clemta.com/contacts \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "message": "Contacts retrieved successfully",
  "data": {
    "contacts": [
      {
        "id": "64b8f1a2e4b0c8d9f0123456",
        "created_at": 1640995200,
        "updated_at": 1640995200,
        "type": "customer",
        "status": "active",
        "full_name": "John Doe",
        "email": "[email protected]",
        "description": "Primary contact for the company",
        "cc_emails": [
          "[email protected]",
          "[email protected]"
        ],
        "bcc_emails": [
          "[email protected]",
          "[email protected]"
        ],
        "billing": {
          "email": "[email protected]",
          "phone": "1234567890",
          "phone_code": "+1",
          "iso_code": "US",
          "country": "United States",
          "address_1": "123 Main Street",
          "address_2": "Suite 100",
          "postal_code": "12345",
          "district": "Downtown",
          "state": "CA",
          "province": "California",
          "tax_id": "12-3456789"
        }
      }
    ],
    "total": 123
  }
}

GET

contacts

Get Contacts

curl --request GET \
  --url https://api.clemta.com/contacts \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "message": "Contacts retrieved successfully",
  "data": {
    "contacts": [
      {
        "id": "64b8f1a2e4b0c8d9f0123456",
        "created_at": 1640995200,
        "updated_at": 1640995200,
        "type": "customer",
        "status": "active",
        "full_name": "John Doe",
        "email": "[email protected]",
        "description": "Primary contact for the company",
        "cc_emails": [
          "[email protected]",
          "[email protected]"
        ],
        "bcc_emails": [
          "[email protected]",
          "[email protected]"
        ],
        "billing": {
          "email": "[email protected]",
          "phone": "1234567890",
          "phone_code": "+1",
          "iso_code": "US",
          "country": "United States",
          "address_1": "123 Main Street",
          "address_2": "Suite 100",
          "postal_code": "12345",
          "district": "Downtown",
          "state": "CA",
          "province": "California",
          "tax_id": "12-3456789"
        }
      }
    ],
    "total": 123
  }
}

List Contacts

This endpoint allows you to retrieve a list of contacts for a company with optional filtering and pagination.

Headers

Parameter	Type	Description
X-API-KEY	string	Formation API Key (required)

Query Parameters

Parameter	Type	Required	Description
company_id	string	Yes	Company ID to filter contacts
skip	string	No	Number of records to skip (pagination)
limit	string	No	Number of records to return (pagination)
search	string	No	Search term to filter contacts
sort	string	No	Field to sort by
order	string	No	Sort order: “asc” or “desc”
created_at	string	No	Created at filter
created_at_value	string	No	Created at value
end_date	string	No	End date filter

Parameter Examples

Basic request: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456
With pagination: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&skip=0&limit=10
With search: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&search=john
With sorting: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&sort=created_at&order=desc

Response

{
  "success": true,
  "message": "Contacts retrieved successfully",
  "data": {
    "contacts": [
      {
        "id": "64b8f1a2e4b0c8d9f0123456",
        "created_at": 1686787200,
        "updated_at": 1686787200,
        "type": "customer",
        "status": "active",
        "full_name": "John Doe",
        "email": "[email protected]",
        "description": "Primary customer contact",
        "cc_emails": ["[email protected]"],
        "bcc_emails": ["[email protected]"],
        "billing": {
          "email": "[email protected]",
          "phone": "+1234567890",
          "phone_code": "+1",
          "iso_code": "US",
          "country": "United States",
          "address_1": "123 Main St",
          "address_2": "Suite 100",
          "postal_code": "12345",
          "district": "Downtown",
          "state": "CA",
          "province": "California",
          "tax_id": "12-3456789"
        }
      }
    ],
    "total": 1,
    "skip": 0,
    "limit": 10
  }
}

Response Parameters

Parameter	Type	Description
success	boolean	Indicates if the operation was successful
message	string	Additional information about the operation
data	object	Response data for successful requests
data.contacts	array	Array of contact objects
data.total	integer	Total number of contacts
data.skip	integer	Number of records skipped
data.limit	integer	Number of records returned

Contact Object Fields

Field	Type	Description
id	string	Unique identifier for the contact
created_at	integer	Creation timestamp
updated_at	integer	Last update timestamp
type	string	Contact type (“customer” or “vendor”)
status	string	Contact status
full_name	string	Full name of the contact
email	string	Email address
description	string	Contact description
cc_emails	array	CC email addresses
bcc_emails	array	BCC email addresses
billing	object	Billing information

Error Responses

Invalid Request (400)

{
  "success": false,
  "message": "Invalid request data",
  "error": {
    "code": "INVALID_REQUEST",
    "details": "Company ID is required"
  }
}

Unauthorized (401)

{
  "success": false,
  "message": "API key is required",
  "error": {
    "code": "API_KEY_REQUIRED"
  }
}

Company Not Found (404)

{
  "success": false,
  "message": "Company not found",
  "error": {
    "code": "COMPANY_NOT_FOUND"
  }
}

Internal Server Error (500)

{
  "success": false,
  "message": "Internal server error",
  "error": {
    "code": "INTERNAL_ERROR"
  }
}

Authorizations

X-API-Key

string

header

required

Formation API key for authentication.

Query Parameters

company_id

string

required

Company ID

skip

string

Number of records to skip

limit

string

Number of records to return

string

Search term

sort

string

Sort field

order

enum<string>

Sort order (asc/desc)

Available options:

asc,

desc

created_at

string

Created at filter

created_at_value

string

Created at value

end_date

string

End date filter

Response

Contacts retrieved successfully

success

boolean

Example:

true

message

string

Example:

"Contacts retrieved successfully"

data

object

Show child attributes

Create Contact

Get Contact by ID

​List Contacts

​Headers

​Query Parameters

​Parameter Examples

​Response

​Response Parameters

​Contact Object Fields

​Error Responses

​Invalid Request (400)

​Unauthorized (401)

​Company Not Found (404)

​Internal Server Error (500)

Authorizations

Query Parameters

Response

List Contacts

Headers

Query Parameters

Parameter Examples

Response

Response Parameters

Contact Object Fields

Error Responses

Invalid Request (400)

Unauthorized (401)

Company Not Found (404)

Internal Server Error (500)