GET
/
api
/
v1
/
users
{
  "hydra:member": [
    {
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "status": "<string>",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "dateCreated": "2023-11-07T05:31:56Z",
      "localCenter": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "alias": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "localCenterParent": "https://example.com/",
      "type": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "position": 123,
        "isUserType": true,
        "options": [
          "<string>"
        ],
        "isLocalCenter": true,
        "isLocalCenterParent": true,
        "isNational": true,
        "chartName": "<string>"
      },
      "fullName": "<string>",
      "isFeeActive": true,
      "isExpiredValidFeeDate": true,
      "townCurrent": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "nameWithCounty": "<string>",
        "country": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>"
        }
      },
      "logo": "<string>",
      "profileWebsite": "<string>",
      "profileFacebook": "<string>",
      "profileTwitter": "<string>",
      "profileLinkedin": "<string>",
      "profileInstagram": "<string>",
      "profileTelegram": "<string>",
      "dateJoined": "2023-11-07T05:31:56Z",
      "isFullMember": true,
      "cardId": "<string>",
      "professionHeadline": "<string>",
      "validFeeDate": "2023-11-07T05:31:56Z",
      "validLocalFeeDate": "2023-11-07T05:31:56Z",
      "lastCardPrintedDate": "2023-11-07T05:31:56Z",
      "feeLocalProductPrice": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "isLifetime": true
      },
      "feeTenantProductPrice": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "isLifetime": true
      },
      "adhesion": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "status": "pending",
        "updatedDate": "2023-11-07T05:31:56Z"
      },
      "dateJoinedFullMember": "2023-11-07T05:31:56Z",
      "professionJob": "https://example.com/",
      "professionExpertise": "https://example.com/",
      "professionSector": "<string>",
      "professionExpertiseOther": "<string>",
      "permissions": [
        "<string>"
      ],
      "customPermissions": [
        "<string>"
      ],
      "isExpiredValidLocalFeeDate": true,
      "isLocalFeeActive": true,
      "profileTiktok": "<string>"
    }
  ],
  "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

​
customFieldValues.value
string
​
customFieldValues.value[]
string[]
​
customFieldValues.field
string
​
customFieldValues.field[]
string[]
​
townCurrent.country
string
​
townCurrent.country[]
string[]
​
email
string
​
email[]
string[]
​
feeTenantProductPrice
string
​
feeTenantProductPrice[]
string[]
​
cardId
string
​
cardId[]
string[]
​
status
string
​
status[]
string[]
​
type
string
​
type[]
string[]
​
firstName
string
​
lastName
string
​
townCurrent
string
​
townCurrent[]
string[]
​
professionIndustry
string
​
professionIndustry[]
string[]
​
professionHeadline
string
​
roles
string
​
order[id]
enum<string>
default:asc
Available options:
asc,
desc
​
order[dateBirth]
enum<string>
default:asc
Available options:
asc,
desc
​
order[dateUpdated]
enum<string>
default:asc
Available options:
asc,
desc
​
order[dateJoined]
enum<string>
default:asc
Available options:
asc,
desc
​
order[lastName]
enum<string>
default:asc
Available options:
asc,
desc
​
order[validFeeDate]
enum<string>
default:asc
Available options:
asc,
desc
​
order[status]
enum<string>
default:asc
Available options:
asc,
desc
​
order[type.position]
enum<string>
default:asc
Available options:
asc,
desc
​
order[isFullMember]
enum<string>
default:asc
Available options:
asc,
desc
​
order[localCenter.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[townCurrent.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[professionUpdateDate]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[professionIndustry]
boolean
​
exists[professionHeadline]
boolean
​
exists[isFullMember]
boolean
​
exists[userRoles.dateEnded]
boolean

Response

User collection

The response is of type object.