Get organization

GET

/api/organization/{organizationid}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.eventpoint.io/api/organization/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"),
    Headers =
    {
        { "x-api-key", "<x-api-key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.eventpoint.io/api/organization/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

You can only retrieve an organization if the context has permission.

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

organizationid

required

string format: uuid

The organization identifier.

Responses

200

object

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

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

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

Get organization

Authorizations

Parameters

Path Parameters

Responses

200

Example

Example

403

Examplegenerated

Examplegenerated

Example^generated

Example^generated