Export Contacts

GET {{url}}/{{tenantName}}/{{instanceName}}/export/CONTACT

This endpoint allows you to retrieve an export of contact data from the specified tenant and instance. The exported data will be in a format suitable for further analysis or integration with other systems.

Request

• Method: GET
• URL: {{url}}/{{tenantName}}/{{instanceName}}/export/CONTACT

Response

The response will contain the exported contact data in a suitable format, typically JSON.

Example

Request:

arduinoCopy codeGET {{url}}/{{tenantName}}/{{instanceName}}/export/CONTACT

Response:

perlCopy code{
  "contacts": [
    {
      "id": "1",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "phone": "123-456-7890"
    },
    {
      "id": "2",
      "name": "Jane Smith",
      "email": "janesmith@example.com",
      "phone": "987-654-3210"
    },
    ...
  ]
}

Error Codes

• 404 Not Found: The specified {{tenantName}} or {{instanceName}} does not exist.

Authentication

Make sure to include appropriate authentication credentials, such as an API key or token, in the request headers for accessing this endpoint.

Rate Limiting

This endpoint may be subject to rate limiting. If you encounter rate limit errors, please wait for a suitable period of time before making additional requests.

Notes

• This endpoint is specifically designed for exporting contact data. If you need to export data of a different type, refer to the corresponding endpoint documentation.
• Ensure that you have the necessary permissions and access rights to retrieve contact data from the specified {{tenantName}} and {{instanceName}}.

Request Params