Organisation /organisation/{organisation-id}

Represents an individual organisation.

Reading

GET /organisation/{organisation-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with workspace_environment permission is required.
  • If access token points to a workspace, the organisation must be attached to the current workspace.
  • If access token points to an user, the current person must be attached to the workspace at which is attached the organisation.

Fields

Name Description Type

_id

The organisation ID.

string

name

The name of the organisation.

string

activity

The activity of the organisation.

string

avatar

The ID of the Photo that represents the avatar of the organisation.

Photo

legal

The legal informations about the organisation.

object[]

siret_code

The siret code of the organisation.

string

naf_code

The naf code of the organisation.

string

rcs_code

The rcs code of the organisation.

string

rm_code

The rm code of the organisation.

string

vat_code

The vat code of the organisation.

string

legal_form

The legal form of the organisation.

string

share_capital

The share capital of the organisation.

number

mails

The mail addresses of the organisation.

object[]

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

phones

The phone numbers of the organisation.

object[]

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

addresses

The postal addresses of the organisation.

object[]

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

notes

Notes about the organisation.

string

custom_fields

Custom fields attached to the organisation.

object

tags

An array of Tag IDs at which is attached the organisation.

Tag[]

workspace

The ID of the Workspace at which is attached the organisation.

Workspace

created_time

The date that indicates when the organisation was created.

date

updated_time

The date that indicates when the organisation was updated for the last time.

date

Computed fields

Name Description Type

main_mail

The main mail address of the organisation.
Taken from mails field (item whose its main field is set to true).

object

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

main_phones

The main phone number of the organisation.
Taken from phones field (item whose its main field is set to true).

object

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

main_addresses

The main postal address of the organisation.
Taken from addresses field (item whose its main field is set to true).

object

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

Publishing

You can't create organisations by using the Nexty API. Please contact us if you want to add a new organisation in your Nexty Platform.

Updating

PUT /organisation/{organisation-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with manage_environment permission is required.
  • If access token points to a workspace, the organisation must be attached to the current workspace.
  • If access token points to an user, the current person must be an admin (with MANAGE permission) of the workspace at which is attached the organisation.

Fields

Name Description Type

name

The name of the organisation.

string

activity

The activity of the organisation.

string

avatar

The ID of the Photo that represents the avatar of the organisation.
Must be a photo attached to the organisation or a photo owned by the current person whose its tmp field is set to true.

Photo

legal

The legal informations about the organisation.

object[]

siret_code

The siret code of the organisation.

string

naf_code

The naf code of the organisation.

string

rcs_code

The rcs code of the organisation.

string

rm_code

The rm code of the organisation.

string

vat_code

The vat code of the organisation.

string

legal_form

The legal form of the organisation.

string

share_capital

The share capital of the organisation.

number

mails

The mail addresses of the organisation.

object[]

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

phones

The phone numbers of the organisation.

object[]

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

addresses

The postal addresses of the organisation.

object[]

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

notes

Notes about the organisation.

string

custom_fields

Custom fields attached to the organisation.

object

tags

An array of Tag IDs at which is attached the organisation.
Must be some Tags belonging to the current person workspace.

string[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Deleting

You can't delete organisations by using the Nexty API. Please contact us if you want to remove an organisation from your Nexty Platform.

Edges

Name Description

/photos

The photos attached to the organisation.

/users

The users attached to the organisation.