ContactsContact Companies
Get Contact Company Details
Get a company's details and its linked contacts.
Returns detailed information about a company and the contacts linked to it.
Required: Contacts > Read
Authorization
bearerToken
AuthorizationBearer <token>
API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.
In: header
Request Body
application/json
project_uid*string
Your project's unique identifier.
company_id*integer
The company ID.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.yourgpt.ai/chatbot/v1/getContactCompanyDetails" \ -H "Content-Type: application/json" \ -d '{ "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "company_id": 50 }'{
"type": "RXSUCCESS",
"data": {
"id": 1001,
"name": "Acme Corp",
"website": "https://acme.com",
"project_id": 12345,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z",
"contacts": [
{
"id": 5001,
"project_id": 12345,
"name": "John Doe",
"email": "john@example.com",
"phone": "+12345678901",
"type": "lead",
"tags": null,
"company_id": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
]
}
}{
"type": "RXERROR",
"message": "Invalid params"
}{
"type": "RXERROR",
"message": "Invalid or revoked API token"
}{
"type": "RXERROR",
"message": "You do not have permission to perform this action"
}