Organizations

The companies they belong to.

List organizations

GET

https://{workspace}.open-helpdesk.com/api/v1

/organizations

List organizations › query Parameters

limit

integer · min: 1 · max: 100

Rows per page.

Default: 25

cursor

string

The next_cursor of the previous page.

List organizations › Responses

List organizations

Organization[] · required

next_cursor

string · required

Pass back as cursor for the next page. Null on the last page.

Create an organization

POST

https://{workspace}.open-helpdesk.com/api/v1

/organizations

Create an organization › Request Body

name

string · maxLength: 200 · required

email_domains

string[] · maxItems: 50

shared_tickets

boolean

notes

string

object

Create an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

POST/organizations

curl 'https://{workspace}.open-helpdesk.com/api/v1/organizations' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Nordfil SAS",
  "email_domains": [
    "nordfil.fr"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}'

Example Request Body

{
  "name": "Nordfil SAS",
  "email_domains": [
    "nordfil.fr"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}

json

Example Responses

{
  "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83",
  "name": "Nordfil SAS",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {},
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Read an organization

GET

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Read an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Read an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

Delete an organization

DELETE

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Its tickets are detached, never deleted: a customer's history outlives the company record.

Delete an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Delete an organization › Responses

Deleted.

No data returned

Update an organization

PATCH

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Update an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Update an organization › Request Body

name

string

email_domains

string[]

shared_tickets

boolean

notes

string

object

Update an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

PATCH/organizations/{id}

curl 'https://{workspace}.open-helpdesk.com/api/v1/organizations/:id' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}'

Example Request Body

{
  "name": "name",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}

json

Example Responses

{
  "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83",
  "name": "Nordfil SAS",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {},
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Contacts Knowledge base

Open HelpDesk API

Organizations

The companies they belong to.

List organizations

GET

https://{workspace}.open-helpdesk.com/api/v1

/organizations

List organizations › query Parameters

limit

integer · min: 1 · max: 100

Rows per page.

Default: 25

cursor

string

The next_cursor of the previous page.

List organizations › Responses

List organizations

Organization[] · required

next_cursor

string · required

Pass back as cursor for the next page. Null on the last page.

Create an organization

POST

https://{workspace}.open-helpdesk.com/api/v1

/organizations

Create an organization › Request Body

name

string · maxLength: 200 · required

email_domains

string[] · maxItems: 50

shared_tickets

boolean

notes

string

object

Create an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

POST/organizations

curl 'https://{workspace}.open-helpdesk.com/api/v1/organizations' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Nordfil SAS",
  "email_domains": [
    "nordfil.fr"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}'

Example Request Body

{
  "name": "Nordfil SAS",
  "email_domains": [
    "nordfil.fr"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}

json

Example Responses

{
  "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83",
  "name": "Nordfil SAS",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {},
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Read an organization

GET

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Read an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Read an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

Delete an organization

DELETE

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Its tickets are detached, never deleted: a customer's history outlives the company record.

Delete an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Delete an organization › Responses

Deleted.

No data returned

Update an organization

PATCH

https://{workspace}.open-helpdesk.com/api/v1

/organizations/{id}

Update an organization › path Parameters

id

string · uuid · required

The organization id.

Example: 3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83

Update an organization › Request Body

name

string

email_domains

string[]

shared_tickets

boolean

notes

string

object

Update an organization › Responses

Success.

Organization

id

string · uuid

name

string

email_domains

string[]

Domains that attach an incoming contact to this company automatically.

shared_tickets

boolean

notes

string

object

created_at

string · date-time

PATCH/organizations/{id}

curl 'https://{workspace}.open-helpdesk.com/api/v1/organizations/:id' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}'

Example Request Body

{
  "name": "name",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {}
}

json

Example Responses

{
  "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83",
  "name": "Nordfil SAS",
  "email_domains": [
    "string"
  ],
  "shared_tickets": true,
  "notes": "notes",
  "custom_fields": {},
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Contacts Knowledge base