API:Reps:Get

API » Get Sales Reps

The Get Sales Reps endpoint retrieves sales representatives (reps) for your CallProof company whose profiles were updated within a specified date range. It supports pagination, making it suitable for synchronizing large teams with external systems.

Base URL

https://app.callproof.com

Endpoint

/api/reps/get/

Purpose

Use this endpoint to:

• Retrieve sales representatives updated within a specified date range.
• Synchronize rep information with external applications.
• Process large result sets using pagination.

HTTP Method

GET

Headers

Header	Required	Description
None	No	This endpoint does not require HTTP headers. Authentication is provided using query parameters.

Security

• Authentication is required.
• Pass the API credentials using the key and secret query parameters.

Parameters

Query Parameters

Parameter	Type	Required	Description
key	string	Yes	Public API key assigned to your CallProof account.
secret	string	Yes	Private API secret associated with the API key.
after	datetime	Yes	Returns only reps updated on or after this date and time. Invalid or missing values return a validation error.
before	datetime	No	Returns only reps updated on or before this date and time. If omitted, no upper date limit is applied.
offset	integer	No	Starting offset for paginated results. Defaults to 0 if omitted or invalid.

Path Parameters

None.

Request Body

None.

Example Request

cURL

curl -X GET "https://app.callproof.com/api/reps/get/?key=YOUR_API_KEY&secret=YOUR_API_SECRET&after=2024-01-01"

Successful Response (200)

Returns a paginated list of sales representatives that match the requested date range. A maximum of 100 records are returned per request. When additional records are available, the more field is set to 1, allowing the next page to be retrieved using the offset parameter.

Field	Type	Description
results	array	List of sales representative objects.
results[].id	integer	Unique identifier of the sales representative.
results[].user_id	integer	Associated CallProof user ID.
results[].email	string	Email address of the sales representative.
results[].name	string	Display name of the sales representative.
results[].title	string	Job title of the sales representative. Returns an empty string if no title is assigned.
results[].updated	string	Date and time the sales representative profile was last updated (YYYY-MM-DD HH:MM:SS).
more	integer	Indicates whether additional matching records exist. 1 = more records available, 0 = last page.
offset	integer	Offset value used to retrieve the current page.
errors	array	Empty when the request completes successfully.
code	integer	HTTP status code returned by the API.

Example Response

{
    "results": [
        {
            "id": 123,
            "user_id": 456,
            "email": "rep@example.com",
            "name": "Jane Smith",
            "title": "Account Executive",
            "updated": "2024-06-15 14:30:00"
        }
    ],
    "more": 0,
    "offset": 0,
    "errors": [],
    "code": 200
}

Error Responses

HTTP Status	Description
400	Bad Request. The required after parameter is missing or contains an invalid date/time value.
401	Unauthorized. The API Key or Secret is missing, invalid, inactive, belongs to a disabled account, or does not have permission to access sales representative data.
405	Method Not Allowed. Only the GET method is supported.
500	Internal Server Error. An unexpected server error occurred.

400 Bad Request

{
    "results": [],
    "errors": [
        "Invalid 'after' field"
    ],
    "code": 400
}

401 Unauthorized

{
    "results": [],
    "errors": [
        "Invalid API Key"
    ],
    "code": 401
}

405 Method Not Allowed

{
    "results": [],
    "errors": [
        "Method not allowed"
    ],
    "code": 405
}

Notes

• Authentication credentials must be supplied as the key and secret query parameters.
• This endpoint does not support Bearer Token authentication.
• Results are limited to a maximum of 100 sales representatives per request.
• Use the offset parameter together with the more response field to retrieve additional pages of results.
• The after parameter is required and must contain a valid date or date-time value.