API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

user_roles

Retrieves the collection of user_roles resources.

Retrieves the collection of user_roles resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
id
integer
id[]
Array of integers
slug
string
slug[]
Array of strings
name
string
name[]
Array of strings
role
string
role[]
Array of strings
search
string
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

tag
string

Filter using tag.

slug_partial
string
id
integer
slug_start_with
string
id
integer
slug_end_with
string
id
integer
slug
string
id_partial
integer
slug
string
id_start_with
integer
slug
string
id_end_with
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}