API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

users

Retrieves the collection of users resources.

Retrieves the collection of users 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
username
string
username[]
Array of strings
person
string
person[]
Array of strings
search
string
enabled
boolean

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

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}

tag
string

Filter using tag.

slug_partial
string
id
integer
username
string
slug_start_with
string
id
integer
username
string
slug_end_with
string
id
integer
username
string
slug
string
id_partial
integer
username
string
slug
string
id_start_with
integer
username
string
slug
string
id_end_with
integer
username
string
slug
string
id
integer
username_partial
string
slug
string
id
integer
username_start_with
string
slug
string
id
integer
username_end_with
string

Responses

Response samples

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