Nexus
Nexus APIs
GET
/v1/organizations/FindByAlias(alias='{alias}',name='{name}')
Gets a list of organizations with the given alias.
Requires the organization.read permission
Parameters
| Name | In | Required | Description |
|---|---|---|---|
alias |
path | Yes | — |
name |
path | Yes | — |
select |
query | No | One or more comma separated fields to select. |
orderby |
query | No | One or more fields to sort by, with optional ascending/descending indicator. (e.g. name DESC) |
filter |
query | No | An OData filter expression. e.g. field_name eq 123 |
top |
query | No | The maximum number of rows to return in the response. |
count |
query | No | Indicates if the response should contain a field with the total count of records. |
expand |
query | No | Indicates if the response should expand nested objects. |
skip |
query | No | Indicates the number of records to skip. Combine with $top for paging operations. |
Responses
200
Example
{
"value": [
{
"id": 0,
"name": "string",
"isActive": false,
"displayName": "string",
"crmAccountId": "string",
"isMfaRequired": false,
"matchedSystemName": "string",
"levenshteinDistance": 0
}
],
"@odata.count": 0,
"@odata.context": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
@odata.context
|
string
|
nullable | — | — |
@odata.count
|
number
|
nullable | — | — |
value
|
— | — | — |
Example
{
"value": [
{
"id": 0,
"name": "string",
"isActive": false,
"displayName": "string",
"crmAccountId": "string",
"isMfaRequired": false,
"matchedSystemName": "string",
"levenshteinDistance": 0
}
],
"@odata.count": 0,
"@odata.context": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
@odata.context
|
string
|
nullable | — | — |
@odata.count
|
number
|
nullable | — | — |
value
|
— | — | — |
Example
{
"value": [
{
"id": 0,
"name": "string",
"isActive": false,
"displayName": "string",
"crmAccountId": "string",
"isMfaRequired": false,
"matchedSystemName": "string",
"levenshteinDistance": 0
}
],
"@odata.count": 0,
"@odata.context": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
@odata.context
|
string
|
nullable | — | — |
@odata.count
|
number
|
nullable | — | — |
value
|
— | — | — |
404
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic