Query project companies

GET

/api/companies/companies

curl --request GET \
  --url 'https://api.eventpoint.io/api/companies/companies?SortDir=Asc' \
  --header 'x-api-key: <x-api-key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

ProjectId

string format: uuid

Keyword

string

CompanyTypeId

string format: uuid

Approved

boolean

Published

boolean

Sort

string

SortDir

Allowed values: Asc Desc

Page

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

PageSize

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

Responses

200

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

name

null | string

displayName

null | string

email

null | string

description

null | string

url

null | string

contactInformation

null | string

companyTypeId

null | string format: uuid

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

imageUrl

null | string

imageAssetId

null | string format: uuid

createdByUserId

null | string format: uuid

socials

null | string

externalId

null | string

approved

boolean

published

boolean

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

meta

null | object

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

null

unknown

Allowed values: Asc Desc

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

null

unknown

Allowed values: Asc Desc

terms

null | string

categories

Array<string> | null

dateLow

null | string format: date-time

dateHigh

null | string format: date-time

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

name

null | string

displayName

null | string

email

null | string

description

null | string

url

null | string

contactInformation

null | string

companyTypeId

null | string format: uuid

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

imageUrl

null | string

imageAssetId

null | string format: uuid

createdByUserId

null | string format: uuid

socials

null | string

externalId

null | string

approved

boolean

published

boolean

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

meta

null | object

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

null

unknown

Allowed values: Asc Desc

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

null

unknown

Allowed values: Asc Desc

terms

null | string

categories

Array<string> | null

dateLow

null | string format: date-time

dateHigh

null | string format: date-time

Example

{
  "sortDir": "Asc",
  "request": {
    "sortDir": "Asc"
  }
}

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

name

null | string

displayName

null | string

email

null | string

description

null | string

url

null | string

contactInformation

null | string

companyTypeId

null | string format: uuid

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

imageUrl

null | string

imageAssetId

null | string format: uuid

createdByUserId

null | string format: uuid

socials

null | string

externalId

null | string

approved

boolean

published

boolean

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

meta

null | object

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

null

unknown

Allowed values: Asc Desc

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

null

unknown

Allowed values: Asc Desc

terms

null | string

categories

Array<string> | null

dateLow

null | string format: date-time

dateHigh

null | string format: date-time

Example

{
  "sortDir": "Asc",
  "request": {
    "sortDir": "Asc"
  }
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}