Get available contact persons for document creation
What are contact persons? Contact persons are users who appear as the addressed recipient in project documents. They represent the client or stakeholder who will receive and review the document.
How contact persons are determined:
- For external projects (projects linked to an organization): Returns all members of the linked organization
- For internal projects: Returns all employees in the workspace
What is returned: A list of users with their ID, full name, position/title, and avatar. This list is used when creating or updating documents to select who should be listed as the contact person in the document header and recipient fields.
Use cases:
- Populate dropdown/select fields when creating documents
- Display available contacts when editing document properties
- Ensure only valid contacts are assigned to documents
GET
/projects/{projectId}/documents/contact-personsAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredPath parameters
projectIdstringrequiredProject ID
Responses
200Contact persons retrieved successfully
Array of
ProjectDocumentUserResponseDtoavatarIdobjectFile ID of the user avatar/profile picture. Null if no avatar is set. Can be used to display user avatars in UI.
idstringrequiredUnique identifier (UUID) for the user. Use this ID when assigning the user as a contact person in document creation/update requests.
namestringrequiredFull name of the user (first name + last name). Displayed in contact person selection lists and document headers.
positionstringrequiredJob title or position of the user within their organization. Displayed alongside the name in contact person selection lists.
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/projects/string/documents/contact-persons" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"const response = await fetch("https://leadtime.app/api/public/projects/string/documents/contact-persons", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
});import requests
response = requests.get(
"https://leadtime.app/api/public/projects/string/documents/contact-persons",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
},
)Response
[
{
"avatarId": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"position": "Project Manager"
}
]Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions