GET /stocks/material-types/folders

Get all material type folders

Returns a paginated list of all material type folders for the authenticated entity, including their full code.

Operation ID: getMaterialTypeFolders

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

Query Parameters

Name	Type	Description
`search_text` query	string	Text string to search for
`sort` query	string	The name of the attribute to use for sort order
`order` query	string	The direction of the sort order `asc` `desc`
`page` query	integer	The page number (1-based) to retrieve the results, according to the `limit` defined
`limit` query	integer	Limit to restrict the number of entries per page

Responses

data array<object>

id string read-only

ID of the Material Type Folder

type string read-only

Model type

stock-material-type-folder

attributes object

material_type_folder_id string read-only

ID of the material type folder

Example: 1

parent_id string

ID of the associated folder of the material type folder

Example: 1

name string

Name of the material type folder

Example: Chemical

code string

Code of the material type folder

Example: CH-00001

created_at string (date-time)

Creation date

Example: 2021-01-01 00:00:00

updated_at string (date-time)

Last update date

Example: 2021-01-01 00:00:00

deleted_at string (date-time) | null

Deletion date

Example: 2021-01-01 00:00:00

full_code string read-only

Full hierarchical code composed of ancestor codes separated by dots

Example: CH.SUB.001

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

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

Sort

Pagination

GET https://api.sandbox.infraspeak.com/v3/stocks/material-types/folders

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/stocks/material-types/folders' \
  -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/stocks/material-types/folders', {
  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/stocks/material-types/folders');

import requests

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

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "string",
        "type": "stock-material-type-folder",
        "attributes": {
            "material_type_folder_id": "1",
            "parent_id": "1",
            "name": "Chemical",
            "code": "CH-00001",
            "created_at": "2021-01-01 00:00:00",
            "updated_at": "2021-01-01 00:00:00",
            "deleted_at": "2021-01-01 00:00:00",
            "full_code": "CH.SUB.001"
        }
    },
    "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"
    }
}

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"
    }
}