Network | Nexus211 API Documentation

get

List networks, 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

OK

application/json

get

/network

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

200

OK

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": [
    {
      "name": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-02-14",
      "updated_at": "2026-02-14"
    }
  ]
}

post

Create a new network

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

namestringRequired

Responses

201

Created

post

/network

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

{
  "name": "text"
}

201

Created

No content

get

Read a network 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 network to get

Responses

200

OK

application/json

404

A network with the specified ID was not found.

get

/network/{id}

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

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

patch

Update an existing network

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 network 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

OK

application/json

404

A network with the specified ID was not found.

patch

/network/{id}

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

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

get

Get a list of network invitations

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

networkstringOptional

Id of network to be joined

organizationstringOptional

Id of the invited organization

Responses

200

Returns the network invitation

application/json

403

You are not authorized to access this invitation.

get

/network-invitation

GET /network-invitation HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "network": "text",
  "organization": "text"
}

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": null
}

post

Invite an organization to a network

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

networkstringOptional

Id of network to be joined

organizationstringOptional

Id of the invited organization

redirectUrlstringOptional

url to redirect after invite is accepted (optional)

Responses

201

Organization has been invited

400

Please provide a valid organization ID.

403

Your organization is not the owner of this network, therefore cannot invite other organizations.

409

This organization is already a member!

post

/network-invitation

POST /network-invitation HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "network": "text",
  "organization": "text",
  "redirectUrl": "text"
}

No content

delete

Kick/remove organization from a network. Can also be used for leaving an organization

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

Responses

201

Created

delete

/network/{id}/members/{organizationId}

DELETE /network/{id}/members/{organizationId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 111

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

201

Created

No content

get

Show a network invitation

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

networkstringOptional

Id of network to be joined

organizationstringOptional

Id of the invited organization

Responses

200

Returns the network invitation

No content

403

You are not authorized to access this invitation.

get

/network-invitation/{id}

GET /network-invitation/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "network": "text",
  "organization": "text"
}

No content

delete

Delete an invitation

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.

Responses

200

deleted

No content

400

You have already joined this network!

403

You are not authorized to access this invitation.

delete

/network-invitation/{id}

DELETE /network-invitation/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

post

Join a network

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.

Responses

200

Joined

No content

403

You are not authorized to access this invitation.

409

You have already joined this network!

post

/network-invitation/{id}/accept

POST /network-invitation/{id}/accept HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

get

List network resources (agencies, sites, resources, services)

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 network to get

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

OK

application/json

get

/network/{id}/resource

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

200

OK

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": {
    "name": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-14",
    "updated_at": "2026-02-14"
  }
}

get

Exports the contacts, transactions, surveys and resources data of given network

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.

Responses

200

OK,

application/json

404

An network with the specified ID was not found.

422

Unable to process the request.

get

/export/network/{id}/json

GET /export/network/{id}/json HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "text"
}