Check User Status

GET https://api.speakap.io/networks/:eid/users/:eid/status

Use cases

  • Check if a user has activated its network profile
  • Find out if a user has been deleted from a network

Authorization

Permissions:get_profile_status

Request

URI:/networks/{networkEID}/users/{userEID}/status
Method:GET
Accept:application/vnd.speakap.api-v1.8.2+json+hal
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID
userEID EID User profile EID

Response

200
Returns the status
403
Unauthorized: returns an Error object
404
Unknown user or network: returns an Error object
Name Type Description
status string active, inactive, canceled, deleted or unknown

The following table explains the meaning of the different statuses:

Status Description
active The user can access the network and has a regular membership.
inactive The user has a pending invite and did not yet finish the registration procedure
canceled The user has been invited, but the pending invitation is removed. The status before canceled was inactive.
deleted An active user is permanently removed from the network. The status before deleted was active.
unknown Unknown EID, profile not found in the current network. Is this EID correct?

Example

{
    "status": "inactive"
}