Resource

Resource operations

get

Retrieve a list of Resources (subject to attribute search criteria)

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Query parameters

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Responses

200

application/json

get

/resource

GET /resource HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

[
  {
    "entityType": "text",
    "entityId": "text",
    "resourceId": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-14",
    "updated_at": "2026-02-14"
  }
]

post

Create a new resource

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

siteIdstringRequired

serviceIdstringRequired

descriptionstringOptional

geoAreaobjectRequired

limitedAvailabilitybooleanOptional

aliasstring[]Optional

Body

sitestringRequired

servicestringRequired

limitedAvailabilitybooleanOptionalDefault: false

visibilitystring · enumOptional

If this is set to private, the resource will not be visible to the public search.

Default: publicPossible values:

aliasstring[]Optional

metadataobjectOptional

Arbitrary structured information

geoAreaobjectOptional

descriptionstringOptional

organizationstring · uuidRequired

Responses

201

Created

post

/resource

POST /resource HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "site": "text",
  "service": "text",
  "limitedAvailability": false,
  "visibility": "public",
  "alias": [
    "text"
  ],
  "metadata": {},
  "geoArea": {},
  "description": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000"
}

201

Created

No content

get

Read a Resource by ID

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the Resource to get

Responses

200

application/json

404

A Resource with the specified ID was not found.

get

/resource/{id}

GET /resource/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "entityType": "text",
  "entityId": "text",
  "resourceId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

patch

Update an existing resource

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

descriptionstringOptional

geoAreaobjectRequired

statusstring · enumOptionalDefault: activePossible values:

limitedAvailabilitybooleanOptional

aliasstring[]Optional

Path parameters

idstringRequired

Unique ID of the resource to get

Header parameters

if-unmodified-sincestringOptional

last update time to make sure request data is not outdated and does not overwrite any data

Responses

200

application/json

404

A resource with the specified ID was not found.

patch

/resource/{id}

PATCH /resource/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "entityType": "text",
  "entityId": "text",
  "resourceId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

Share an existing resource with a network.

Single Resource: Use a specific resource ID to share one resource.

Bulk Sharing: Use id="all" to share multiple resources at once.

Filtering (Bulk Only): When using id="all", you can filter resources using query parameters.

Examples:

Share all resources with taxonomy code starting with "BD": POST /resource/all/share?taxonomyCode=BD
Share resources by exact taxonomy code: POST /resource/all/share?taxonomyCode=BD-1000.2000-1000
Share resources by status: POST /resource/all/share?status=active
Combine filters: POST /resource/all/share?taxonomyCode=BD&status=active

The taxonomyCode parameter filters by service taxonomy using prefix matching (e.g., BD matches BD-1000, BD-1800, BD-1000.2000-1000, etc.).

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

networkstring · uuidRequired

Path parameters

idstringRequired

Resource ID or "all" for bulk sharing

Query parameters

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Body

networkstring · uuidRequired

The network ID to share resources with

Responses

200

Single resource shared successfully

application/json

201

Single resource created in network

application/json

202

Bulk sharing request accepted and processing

application/json

400

Bad request - network not found or no resources matched

404

A resource with the specified ID was not found

post

/resource/{id}/share

POST /resource/{id}/share HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "network": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "text"
}

post

Remove a shared resource from a network.

Single Resource: Use a specific resource ID to unshare one resource.

Bulk Unsharing: Use id="all" to unshare multiple resources at once.

Filtering (Bulk Only): When using id="all", you can filter resources using query parameters.

Examples:

Unshare all resources with taxonomy code starting with "BD": POST /resource/all/unshare?taxonomyCode=BD
Unshare by exact taxonomy code: POST /resource/all/unshare?taxonomyCode=BD-1000.2000-1000
Combine with status filter: POST /resource/all/unshare?taxonomyCode=BD&status=inactive

See the /resource/{id}/share endpoint documentation for more examples.

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

networkstring · uuidRequired

Path parameters

idstringRequired

Resource ID or "all" for bulk unsharing

Query parameters

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Body

networkstring · uuidRequired

The network ID to unshare resources from

Responses

200

Resource(s) unshared successfully

application/json

202

Bulk unsharing request accepted and processing

400

Bad request - network not found or no resources matched

404

A resource with the specified ID was not found

post

/resource/{id}/unshare

POST /resource/{id}/unshare HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "network": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "text",
  "queue": 1
}

post

Attaches the given aux entity of a site to a resource in the same site

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

elementIdstring · uuidRequired

elementTypestringRequiredPattern: ^(email|phone|contact-person)$

Path parameters

idanyRequired

ID of the resource which the site entity will be attached to

Responses

200

application/json

Responseany

400

Attached ${elementType} should belong to site of target resource

404

A resource with the specified ID was not found.

post

/resource/:id/attach

POST /resource/:id/attach HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

post

Detaches the given aux entity of a site from a resource

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

elementIdstring · uuidRequired

elementTypestringRequiredPattern: ^(email|phone|contact-person)$

Path parameters

idanyRequired

ID of the resource which the site entity will be detached from

Responses

200

application/json

400

Attached ${elementType} should belong to site of target resource

404

A resource with the specified ID was not found.

post

/resource/:id/detach

POST /resource/:id/detach HTTP/1.1
Authorization: Basic username:password
Accept: */*

get

Perform flexible searches of resource information

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Query parameters

querystringRequired

Elastic Search query. It can be in the query string query format or match query.

aggregationsobjectOptional

Elastic Search aggregations.

networkstring · uuidOptional

Find results in a specific network.

showInactivebooleanOptional

Include inactive resources in the results. Defaults to false.

scopestring · enumOptional

If you passed a network id, the default scope is to search only in the network. Use this to search in the network and organization.

Possible values:

latnumber · floatOptional

User's latitude. Used for distance calculation.

lonnumber · floatOptional

User's longitude. Used for distance calculation.

zipcodestringOptional

User's zipcode. Used for distance calculation. Can be used instead of lat/lon

distancenumberOptional

Filters results by distance from user.

distanceUnitstring · enumOptional

Unit of distance. Defaults to miles.

Default: miPossible values:

sortByDistancestring · enumOptional

Sorts results by distance from user.

Possible values:

eligibilityLatnumberOptional

Latitude for eligibility area match.

eligibilityLonnumberOptional

Longitude for eligibility area match.

openAtDaystring · enumOptional

Day of week, starting from Monday. For example 4 is thursday.

Possible values:

openAtMinutestringOptional

Minute of the day. For example 450 is 07:30am

sortstringOptional

includestringOptional

Comma-separated list of fields to include in the response. Example: id,service.name,site.name

excludestringOptional

Comma-separated list of fields to exclude from the response. Example: id,service.name,site.name

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

Responses

200

application/json

400

The server was unable to understand your request

get

/search/resource

GET /search/resource?query=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

[
  {
    "entityType": "text",
    "entityId": "text",
    "resourceId": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-14",
    "updated_at": "2026-02-14"
  }
]

PreviousReferral NextService

Last updated 9 days ago