API reference
People
Who a contributor is in these books: their name, picture and role while they are a member.
Guides: See who did the accounting work
Get who a contributor is in the books
GET/v1/people/{user_id}
client.people.get()
Who a contributor is in these books: their name, picture and role while they are a member. Someone who has left keeps their work, under their id alone. Anyone who never worked in these books is not found.
Parameters
| Name | Type | Description |
|---|---|---|
user_idPath · Required | string | An id that starts with |
Response
200PersonOut
Errors
- 400
- The request was malformed or a parameter is invalid.
- 401
- No valid credential was sent.
- 403
- The credential or the member's role does not allow this.
- 404
- No such resource in this ledger.
- 409
- A conflicting request, e.g. one with the same Idempotency-Key still running.
- 422
- A well-formed request a business rule refused.
- 429
- Too many requests; retry after the Retry-After header.
- 500
- Something failed on our side; the request_id identifies it.
Example
curl "https://api.ledgerit.ai/v1/people/{user_id}" \
-H "Authorization: Bearer $LEDGERIT_TOKEN"Objects
The objects these operations take and return.
PersonOut
| Name | Type | Description |
|---|---|---|
actorRequired | ContributorOut | |
memberRequired | boolean | Whether they are in these books now. |
member_since | string (date-time) or null | When they joined these books. |
ContributorOut
| Name | Type | Description |
|---|---|---|
avatar_url | string or null | Their profile picture, when they have one. |
email | string or null | Their email, while they are in these books; null once they leave. |
id | string or null | An id that starts with |
kindRequired | string |
user, system, model |
name | string or null | Their name, while they are in these books and gave one; null otherwise. |
role | string or null | Their role in these books ( |