Get Event-Users Details

From docs
Jump to: navigation, search

Mobile_API »Get Event Users

Base URL

https://apimobile.callproof.com

Endpoint

/api/event-users

Purpose

Retrieves the list of active users available for event filtering/selection. Users are limited by market visibility rules: when “just my events” is enabled for the authenticated user, the list is empty; otherwise it includes same-market users who have not hidden their events and are not disabled.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/event-users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/event-users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns the eligible event users for the authenticated user’s company context.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data object Event users payload
uri string Requested resource URI

data.users[]

Field Type Description
id integer Unique identifier of the user
full_name string Full name (first name + last name)
username string Username
email string Email address

Error Responses

Status Code Meaning
400 Bad Request – event users could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving the event users list (for example, "Error while retriving the Events User list").
  • 401 – Authentication failed or the access token is missing/expired.