Repzo API - Rep (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Rep (Sales Representative) endpoints.

Find reps

query Parameters

object

Query parameters for filtering reps

Responses

Response samples

Content type

application/json

{"data": [{"_id": "string",
"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true,
"rep_can_add_calendar": true,
"rep_can_edit_calendar": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0,
"first_page_url": "string",
"last_page_url": "string",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string"
}

Create a rep

Request Body schema: application/json

name required	string Name of the rep
email required	string Email of the rep
username	string Username of the rep
phone	string Phone number of the rep
role required	string Role of the rep
team_id	string ID of the team the rep belongs to
password required	string Password for the rep account
disabled	boolean Whether the rep is disabled
	object Rep permissions
	object Rep settings
	object Integration metadata
company_namespace required	Array of strings Company namespaces

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
]
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true,
"rep_can_add_calendar": true,
"rep_can_edit_calendar": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a rep by ID

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true,
"rep_can_add_calendar": true,
"rep_can_edit_calendar": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a rep

path Parameters

required

string

Request Body schema: application/json

name	string Name of the rep
email	string Email of the rep
username	string Username of the rep
phone	string Phone number of the rep
role	string Role of the rep
team_id	string ID of the team the rep belongs to
password	string Password for the rep account
disabled	boolean Whether the rep is disabled
	object Rep permissions
	object Rep settings
	object Integration metadata
company_namespace	Array of strings Company namespaces
_id	string Unique identifier for the rep
createdAt	string <date-time> Creation timestamp
updatedAt	string <date-time> Last update timestamp
__v	number Version number

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true,
"rep_can_add_calendar": true,
"rep_can_edit_calendar": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Remove a rep

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"email": "string",
"username": "string",
"phone": "string",
"role": "string",
"team_id": "string",
"password": "string",
"disabled": true,
"permissions": {"rep_can_add_client": true,
"rep_can_edit_client": true,
"rep_can_add_calendar": true,
"rep_can_edit_calendar": true
},
"settings": {"allowable_accuracy": 0
},
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}