Organization | Nexus211 API Documentation

get

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

/organization

GET /organization 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 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

namestringRequired

Name of the organization

descriptionstringOptional

Description of the organization

citystringOptional

City where the organization is located

statestringOptional

State where the organization is located

countrystringOptional

Country where the organization is located

timezonestringOptional

Timezone where the organization is located

emailstringOptional

Email of the organization

addressstringOptional

Address of the organization

Responses

201

Created

post

/organization

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

{
  "name": "text",
  "description": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "timezone": "text",
  "email": "text",
  "address": "text"
}

201

Created

No content

get

Search organizations by name

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

namestringRequired

Responses

200

OK

application/json

get

/search/organization

GET /search/organization?name=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

OK

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

get

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

Responses

200

OK

application/json

404

A organization with the specified ID was not found.

get

/organization/{id}

GET /organization/{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 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

Path parameters

idstringRequired

Unique ID of the organization 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 organization with the specified ID was not found.

patch

/organization/{id}

PATCH /organization/{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"
}

post

Invite someone to 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

organizationstringOptional

ID of organization to be joined

emailstringOptional

E-mail of the invitee

rolesstring[]Optional

Roles of the invited user

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

/invitation

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

{
  "organization": "text",
  "email": "text",
  "roles": [
    "text"
  ]
}

No content

get

Display 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

Returns invitation

No content

get

/invitation/{id}

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

200

Returns invitation

No content

delete

Delete an invitation to join 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.

Responses

200

Invitation deleted.

No content

400

This invitation has already been processed.

403

You are not authorized to access this invitation.

delete

/invitation/{id}

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

No content

post

Join 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.

Responses

201

Profile created

400

This invitation has already been accepted.

409

Another profile has the same email or the current user already is part of the organization.

post

/invitation/{id}/accept

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

No content

post

Decline an invitation to join 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.

Responses

200

Invitation declined

No content

400

This invitation has already been accepted.

404

Could not find any entity of type "Invitation" matching: "Hx..."

post

/invitation/{id}/decline

POST /invitation/{id}/decline HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

post

Invite one or more members to an organization (batch support, organization-scoped apps only, member role only)

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

ID of the organization

Body

Responses

201

Invitations processed (check individual results for success/failure)

application/json

400

Invalid request (empty array, exceeds max size, etc.)

403

Token's organization doesn't match id parameter

422

Validation errors

post

/organization/{id}/invite-member

POST /organization/{id}/invite-member HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "invitations": [
    {
      "email": "[email protected]",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "results": [
    {
      "email": "text",
      "success": true,
      "invitation": {
        "id": "text",
        "organization": "text",
        "email": "text",
        "roles": [
          "text"
        ],
        "invitedBy": "text",
        "createdAt": "2026-02-14T19:37:21.703Z"
      },
      "error": "text"
    }
  ]
}

delete

Cancel/delete a pending invitation (organization-scoped apps only)

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

ID of the organization

invitationIdstringRequired

ID of the invitation to delete

Responses

200

Invitation deleted successfully

application/json

400

Invitation has already been accepted

403

Token's organization doesn't match or invitation doesn't belong to organization

404

Invitation not found

delete

/organization/{id}/invitation/{invitationId}

DELETE /organization/{id}/invitation/{invitationId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "success": true,
  "message": "text"
}

get

Read the members of organization 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 organization to get

Query parameters

withInvites,stringOptional

send 1 to fetch invites as well

Responses

200

OK

application/json

Responseany

403

You're not authorized to display the members of this organization.

404

A organization with the specified ID was not found.

get

/organization/{id}/members

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

No content

delete

Remove member from 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.

delete

/organization/{id}/members/{memberId}

DELETE /organization/{id}/members/{memberId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

post

Remove member from organization (for organization apps).

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.

post

/organization/{id}/member/{memberId}/remove

POST /organization/{id}/member/{memberId}/remove HTTP/1.1
Authorization: Basic username:password
Accept: */*

post

Leave 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.

post

/organization/leave

POST /organization/leave HTTP/1.1
Authorization: Basic username:password
Accept: */*

get

Exports the contacts, transactions, surveys and resources data of given 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.

Responses

200

OK,

application/json

404

An organization with the specified ID was not found.

422

Unable to process the request.

get

/export/organization/{id}/json

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

{
  "id": "text"
}