/organizations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

To create an organization in your application through the API.

When creating the organization via the API, you must include at least the organization's name.

You'll also need to authenticate this request by adding header called "Authorization" with value set to "go-api:<ApiKey>", where <ApiKey> is the API key which you can find in Lime Go under "Settings" > "Integrations" > "Lime Go API-Keys"

DISCLAIMER:

LIMITATION: The given endpoint has a request limit 10 per minute to maintain performance. Exceeding this limit may result in throttling or denial of requests.

Body Params
string
required

[Required] Company Name

string
Defaults to NULL

Organization Number

string
Defaults to NULL

The web site of the company

string
Defaults to NULL

The phone number of the company

string
Defaults to NULL

The fax number of the company

string
Defaults to NULL

The email address of the company

string
Defaults to NULL

The name of the responsible coworker

PostalAddress
object

The postal address of the company

string
Defaults to NULL

The identity in external system

int32

The ID of the target list that we intend to assign the organization

string

The relation with the company. The value can be in either PascalCase or SNAKE_CASE, including the following options: NoRelation (NO_RELATION), WorkingOnIt (WORKING_ON_IT), IsACustomer (IS_A_CUSTOMER), WasACustomer (WAS_A_CUSTOMER), and BeenInTouch (BEEN_IN_TOUCH).

string

An array of tags to be attached to a given organization

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json