GET
/
api
/
v1
/
user_roles
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "role": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "unitType": "https://example.com/",
        "position": 123,
        "isUserType": true,
        "options": [
          "<string>"
        ],
        "isLocalCenter": true,
        "isLocalCenterParent": true,
        "isNational": true,
        "permissions": [
          "<string>"
        ],
        "chartName": "<string>"
      },
      "user": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "status": "<string>",
        "type": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>",
          "namePlural": "<string>",
          "unitType": "https://example.com/",
          "position": 123,
          "isUserType": true,
          "options": [
            "<string>"
          ],
          "isLocalCenter": true,
          "isLocalCenterParent": true,
          "isNational": true,
          "permissions": [
            "<string>"
          ],
          "chartName": "<string>"
        },
        "age": 123,
        "fullName": "<string>",
        "logo": "<string>",
        "phoneNumber": "<string>",
        "cardId": "<string>",
        "feeTenantProductPrice": "https://example.com/",
        "postalCode": "<string>",
        "address": "<string>",
        "professionOrganisation": "<string>",
        "professionOrganisationRole": "<string>",
        "companyIdentifier": "<string>",
        "companyName": "<string>",
        "companyAddress": "<string>",
        "companyRegNo": "<string>"
      },
      "unit": "https://example.com/",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateEnded": "2023-11-07T05:31:56Z",
      "isAdmin": true
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

unit
string
unit[]
string[]
user
string
user[]
string[]
role
string
role[]
string[]
role.unitType
string
role.unitType[]
string[]
role.isNational
boolean
role.isNational[]
boolean[]
role.isLocalCenter
boolean
role.isLocalCenter[]
boolean[]
user.status
string
user.status[]
string[]
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[user.lastName]
enum<string>
default:asc
Available options:
asc,
desc
order[role.position]
enum<string>
default:asc
Available options:
asc,
desc
exists[dateEnded]
boolean
exists[role.isLocalCenter]
boolean
exists[role.isNational]
boolean

Response

200
application/ld+json

UserRole collection

The response is of type object.