GET /materials Deprecated

List all family/group of materials

This endpoint allows you to list all the materials created as FOLDER (material that is the parent of other materials, as a family or group of materials)

Operation ID: getMaterials

lock This endpoint requires a Bearer token in the Authorization header.

Responses

data array<object>

id string required read-only

ID of the Material

Example: 1

type string required read-only

Model type

material

Example: material

attributes object required

material_id integer read-only

ID of the material

Example: 1

parent_id integer read-only

ID of the associated folder of the material

Example: 1

name string

Name of the material

Example: Chair

code string

Code of the material

Example: CH-00001

full_code string read-only

Full code of the material (folders prefix included)

Example: FOLDER.CH-00001

observations string | null

Material observations

Example: This is a observation

is_real boolean

Indicates if this is a real material or a parent folder of materials

Example: 1

units string

Indicates which kind of unit should this material be measured with

Example: un

mean_price object

Mean price of the material

Example: 8

has_children boolean

Indicates if this material is a parent of other materials

Example: 1

default_sell_price number

The default sell price of the material

Example: 10

default_sell_vat number

The default sell VAT of the material

Example: 23

is_from_network boolean

Indicates if the material was shared via Infraspeak Network

Example:

purchase_consumption_type string

Purchase consumption type of the material

INHERIT AUTOMATIC MANUAL

Example: INHERIT

meta object

Meta model structure details

pagination object

total integer required

Total items.

Example: 1

count integer required

Total items returned for the current page.

Example: 1

per_page integer required

Maximum number of records per page.

Example: 1

current_page integer required

Number of the current page.

total_pages integer required

Number of the total pages.

links object

Requests that return multiple items include a `links` attribute, with links related to request's context.

self string required read-only

Current response link.

Example: /path?page=1

first string required read-only

Link to the first page result.

Example: /path?page=1

last string required read-only

Link to the previous page result.

Example: /path?page=1

next string read-only

Link to the next page result.

Example: /path?page=1

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

filter_alt Filters

Pagination

GET https://api.sandbox.infraspeak.com/v3/materials

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/materials' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/materials', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/materials');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/materials',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "1",
        "type": "material",
        "attributes": {
            "material_id": 1,
            "parent_id": 1,
            "name": "Chair",
            "code": "CH-00001",
            "full_code": "FOLDER.CH-00001",
            "observations": "This is a observation",
            "is_real": true,
            "units": "un",
            "mean_price": 8,
            "has_children": true,
            "default_sell_price": 10,
            "default_sell_vat": 23,
            "is_from_network": false,
            "purchase_consumption_type": "INHERIT"
        }
    },
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 1,
            "current_page": 0,
            "total_pages": 0
        }
    },
    "links": {
        "self": "/path?page=1",
        "first": "/path?page=1",
        "last": "/path?page=1",
        "next": "/path?page=1"
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}