v1

latestOpenAPI 3.0.02026-07-261090122.9 KB
Material Lists

Get Material List by ID

get/material-list/{id}

Path parameters

idstring required

Query parameters

filterstring

Array of attribute, operator, and value parts.

asnstring

Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.

relstring

array consisting of indices with the desired relation to include

withCustomfieldsAndRelatedDatastring

If true, response will contain custom fields data

by_viewstring

Filter by view mode. Acceptable values all, team, my

by_entitystring

Filter by entity. Acceptable values job, project, invoice, order, estimate. Required if entity_id is provided

by_entity_idstring

Filter by existing entity id listed for by_entity parameter

from_job_start_timestring

Filter by job start time

to_job_end_timestring

Filter by job end time

unscheduledstring

Filter by unscheduled jobs

Response

Successful response