Type Usages

Type usage lookup values (read-only).

Endpoints

GET

Methods

Read only

Access

Base path

/api/v1/type-usages

Route parameters

Pass public sid values for these route parameters.

{typeUsage}

Example request

curl -X GET 'https://beta.dzconfig.com/api/v1/type-usages?per_page=10' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Endpoints

Method	Path	Purpose
GET	`/api/v1/type-usages`	List type usages
GET	`/api/v1/type-usages/{typeUsage}`	Get type usage details

Query parameters

Parameter	Type	Description
`page`	integer	Page number. Defaults to 1.
`per_page`	integer	Items per page. Values are clamped from 1 to 100.
`search`	string	Match type usage name.

Example response

{
    "data": {
        "id": 1,
        "sid": "fG2hIj",
        "name": "Military"
    }
}

Paginated list shape

{
    "data": [
        {
            "sid": "abc123xy",
            "...": "resource fields"
        }
    ],
    "links": {
        "first": "https://beta.dzconfig.com/api/v1/type-usages?page=1",
        "last": "https://beta.dzconfig.com/api/v1/type-usages?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 1
    }
}

Status codes

Code	Label	Description
`200`	OK	Returned for successful reads, updates, and deletes.
`401`	Unauthorized	Missing or invalid bearer token.
`403`	Forbidden	Your plan or permissions do not allow this action.
`404`	Not found	The route parameter did not match an accessible resource.
`429`	Rate limited	Too many API requests in a short period.