Query project locations

GET

/api/projects/{projectid}/locations

curl --request GET \
  --url https://api.eventpoint.io/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations \
  --header 'x-api-key: <x-api-key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

projectid

required

string format: uuid

The project identifier.

Query Parameters

keyword

string

The optional search keyword.

page

integer | string format: int64

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

The one-based page number.

pagesize

integer | string format: int64

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

The number of items per page.

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

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

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

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

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

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

publish

boolean

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+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

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

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

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

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

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

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

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

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

publish

boolean

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+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

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

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

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

{
  "data": [
    {
      "locationKind": "None"
    }
  ],
  "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

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

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

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

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

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

publish

boolean

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+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

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

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

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

{
  "data": [
    {
      "locationKind": "None"
    }
  ],
  "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"
}