Get organization by code

GET

/api/organization/get-for-code

curl --request GET \
  --url https://api.eventpoint.io/api/organization/get-for-code \
  --header 'x-api-key: <x-api-key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

code

string

The code.

Responses

200

OK

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

code

null | string

name

null | string

description

null | string

url

null | string

userId

string format: uuid

flagLevel

Allowed values: OK Annoying Abusive Spam FreakingSpam

isLocked

boolean

enforceDomain

boolean

domain

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

requireIdenityProvider

boolean

identityProviderName

null | string

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

customUrl

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

parentId

null | string format: uuid

topLevelId

string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

code

null | string

name

null | string

description

null | string

url

null | string

userId

string format: uuid

flagLevel

Allowed values: OK Annoying Abusive Spam FreakingSpam

isLocked

boolean

enforceDomain

boolean

domain

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

requireIdenityProvider

boolean

identityProviderName

null | string

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

customUrl

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

parentId

null | string format: uuid

topLevelId

string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

Example

{
  "flagLevel": "OK"
}

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

code

null | string

name

null | string

description

null | string

url

null | string

userId

string format: uuid

flagLevel

Allowed values: OK Annoying Abusive Spam FreakingSpam

isLocked

boolean

enforceDomain

boolean

domain

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

requireIdenityProvider

boolean

identityProviderName

null | string

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

customUrl

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

parentId

null | string format: uuid

topLevelId

string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

Example

{
  "flagLevel": "OK"
}

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"
}

404

Not Found

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"
}