Skip to content

List company members

GET
/api/companies/{companyid}/members
curl --request GET \
--url https://api.eventpoint.io/api/companies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members \
--header 'x-api-key: <x-api-key>'
companyid
required
string format: uuid

The company identifier.

OK

object
page
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
cacheToken
null | string
count
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
numberOfPages
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
data
Array<object> | null
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
companyId
string format: uuid
userId
null | string format: uuid
personId
null | string format: uuid
organizationId
null | string format: uuid
role
string
name
null | string
firstName
null | string
lastName
null | string
email
null | string
contactEmail
null | string
phone
null | string
description
null | string
contactInformation
null | string
jobTitle
null | string
company
null | string
isEmployed
boolean
imageUrl
null | string
imageAssetId
null | string format: uuid
style
object
hasStyle
boolean
primaryColor
null | string
secondaryColor
null | string
backgroundColor
null | string
textColor
null | string
contrastColor
null | string
fontFamily
null | string
secondaryContrastColor
null | string
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
sort
null | string
sortDir
One of:
null
request
object
page
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
sort
null | string
sortDir
One of:
null
terms
null | string
categories
Array<string> | null
dateLow
null | string format: date-time
dateHigh
null | string format: date-time

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string