get https://sandbox.legislate.tech/v1/collaborators/
This operation will retrieve details about a given collaborator.
A Collaborator is a User who is associated with a contract. You might need to get the details of a Collaborator
A Collaborator will have the following properties:
| Property | Format | Purpose |
|---|---|---|
| Collaborator ID | integer | The contract collaborator's ID |
| Contract ID | integer | The Contract the collaborator is associated with |
| Role | Party , Collaborator , Signatory , Supporting signature | A role determines if the collaborator should sign or can make changes to the contract and parties. |
| Side | First,Second | The first side is the side of the contract creator, the second of the invited parties. |
| Fields | Json | The details of the collaborator stored as name/value pairs in a Json. |
| User ID | Integer | The Collaborator's user ID |
| The collaborator's email | ||
| Collaborator name | String | The collaborator's name |
How to try the endpoint?
To fetch the details of a collaborator, simply provide the collaborator Id in the PATH PARAMS entry below and click Try It! on the right!
Collaborator ID
Please note that the collaborator ID is not the same as the user ID. Collaborator IDs are unique to each Contract configuration.