To ensure the appropriate amount of information given the context of a request, digests are used to represent resources returned as part of another resource. For example, when retrieving users from the /users
endpoint, the API returns the full User
resource. However, when retrieving tasks from the /tasks
endpoint, the assignee
field returns a digest User
, which contains only the user's ID, display name, and email address.
If you need more information than returned in a resource's digest, use the resource's id
to retrieve the full representation from its endpoint. For example, you can use a task's assignee
id
to retrieve the full User
resource from the /users
endpoint.