Organization Namespace
The organization namespace contains the resource to manage organizations with the following Methods Method Endpoint Scope Description.
| Operation | Method | Endpoint | Scope | Sample | Description |
| Create Organization | Post | organization | Organization | Sample | Create Organization |
| Create Organization Email | Post | organization/email/organization_id | Organization | Sample | Create Organization Email |
| Add Organization Address | Post | organization/address/organization_id | Organization | Sample | Add Organization Address |
| Create Organization Phone | Post | organization/phone/organization_id | Organization | Sample | Create Organization Phone |
| Create Organization Social Media | Post | organization/social_media/organization_id | Organization | Sample | Create Organization Social Media |
| Update Organization | Put | organization/organization_id | Organization | Sample | Update Organization |
| Update Organization Email | Put | organization/email/organization_id | Organization | Sample | Update Organization Email |
| Update Organization Phone | Put | organization/phone/organization_id | Organization | Sample | Update Organization Phone |
| Update Organization Address | Put | organization/address/organization_id | Organization | Sample | Update Organization Address |
| Get Organization | Get | organization/organization_id | Organization | Sample | Get Organization |
| Get Organization Email(s) | Get | organization/email/organization_id | Organization | Sample | Get Organization Email(s) |
| Get Organization Phone(s) | Get | organization/phone/organization_id | Organization | Sample | Get Organization Phone(s) |
| Get Organization Address | Get | organization/address/organization_id | Organization | Sample | Get Organization Address |
| Get Organization History | Get | organization/history/organization_id | Organization | Sample | Get Organization History |
| Get Organization History Latest | Get | organization/history/latest/organization_id | Organization | Sample | Get Organization History Latest |
| Get Organization Relationship | Get | organization/relationship/organization_id | Organization | Sample | Get Organization Relationship |
| Get Organization User (Linked User) | Get | organization/user/organization_id | Organization | Sample | Get Organization User (Linked User) |
| Get Organization Account (Linked Account) | Get | organization/account/organization_id | Organization | Sample | Get Organization Account (Linked Account) |
| Delete Organization | Delete | organization/organization_id | Organization | Sample | Delete Organization |
| Delete Organization Email | Delete | organization/email/organization_id | Organization | Sample | Delete Organization Email |
| Delete Organization Phone | Delete | organization/phone/organization_id | Organization | Sample | Delete Organization Phone |
| Delete Organization Address | Delete | organization/address/organization_id | Organization | Sample | Delete Organization Address |
Data Object
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| organization_data | |||||||
| info Security Type: None |
Object | None | R | O | NA | NA | |
| details Security Type: None |
Object | None | R | O | NA | NA | |
| address Security Type: None |
Object | None | O | O | NA | NA | |
| email Security Type: None |
Object | None | R | O | NA | NA | |
| phone Security Type: None |
Object | None | R | O | NA | NA | |
| ownership_json Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | "" | R | O | NA | NA |
| json Security Type: None |
String | None | O | O | O | O | |
| social_media Security Type: None |
Object | None | R | O | NA | NA | |
| classification Security Type: None |
Object | None | R | O | NA | NA | |
| GeoCoordinates Security Type: None |
Object | None | R | O | NA | NA | |
| history Security Type: None |
Object | None | O | O | O | O | |
| WorkingHour Security Type: None |
Object | None | R | O | NA | NA | |
| relationship Security Type: None |
Object | None | O | O | O | O | |
| documents Security Type: None |
Object | None | C | NA | NA | NA | |
| picture Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | O | NA |
| info | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | NA |
| program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | R | NA | NA |
| entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | C | NA | NA | NA |
| entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| local_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
| name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | R | O | NA | NA |
| status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | O | NA | NA |
| verification_status Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | OP | OP | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| date_utc Security Type: None |
String | NA | NA | NA | NA | ||
| source_time_zone Security Type: None |
String | ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ | UTC -06:00, UTC +02:30 | NA | NA | NA | NA |
| source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | O | O | NA | NA |
| details | |||||||
| established_date Security Type: None |
String | NA | NA | NA | NA | ||
| size Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| registration_number Security Type: None |
string | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| trade_license_number Security Type: None |
string | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| address | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | R |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | NA | NA |
| is_primary Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
| is_billing Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
| address_line1 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
| address_line2 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
| postal_zip_code Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{1,20}$ | Abc00, fʁɑ̃s123 | R | O | NA | NA |
| state_region Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
| city_town Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
| country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | R | O | NA | NA |
| status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | C | C | NA | NA |
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | R |
| address Security Type: None |
String | ^(?!.*--)([\w-+\.]{1,80})@([\w-+\.]{1,80})\.([a-zA-Z]{1,20})$ | John.Smith@example.com | R | O | NA | NA |
| verification_status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | OP | OP | NA | NA |
| is_primary Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | R | O | NA | NA |
| custom_field Security Type: None |
Object | None | O | NA | NA | NA | |
| phone | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | R |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | NA | NA |
| country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | R | O | NA | NA |
| number Security Type: None |
String | ^[+]([1-9])\d{7,14}$ | +15180000000 | R | O | NA | NA |
| verification_status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | OP | OP | NA | NA |
| is_primary Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | R | O | NA | NA |
| custom_field Security Type: None |
Object | None | O | NA | NA | NA | |
| social_media | |||||||
| original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | O | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
| address Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | "https://www.google.com" | R | O | NA | NA |
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | R |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | O | NA | NA |
| date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | O | NA | NA |
| update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | O | NA | NA |
| classification | |||||||
| mcc Security Type: None |
String | None | O | O | O | O | |
| sic Security Type: None |
String | None | O | O | O | O | |
| revenue_class Security Type: None |
String | None | O | O | O | O | |
| emp_class Security Type: None |
String | None | O | O | O | O | |
| channel_type Security Type: None |
String | None | O | O | O | O | |
| custom Security Type: None |
String | None | O | O | O | O | |
| geo_coordinates | |||||||
| latitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | O | O | O | O | |
| longitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | O | O | O | O |
| position_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| history | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| by_entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| by_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| json Security Type: None |
String |
(?(DEFINE)
(? |
{ "Object": [ { "property1": "value1", "property2": "value2" } ] } | NA | NA | NA | NA |
| notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
| admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
| original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | NA | NA |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| working_hours | |||||||
| saturday Security Type: None |
String | None | O | O | O | O | |
| sunday Security Type: None |
String | None | O | O | O | O | |
| monday Security Type: None |
String | None | O | O | O | O | |
| tuesday Security Type: None |
String | None | O | O | O | O | |
| wednesday Security Type: None |
String | None | O | O | O | O | |
| thursday Security Type: None |
String | None | O | O | O | O | |
| friday Security Type: None |
String | None | O | O | O | O | |
| relationship | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| on_entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| on_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
| status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| verification_status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
| original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | O | O | O | O |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
| date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
| update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
| custom_field Security Type: None |
Object | None | O | O | O | O | |
Create Organization
Create Organization
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Create Organization Email
Create Organization Email
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Add Organization Address
Add Organization Address
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Create Organization Phone
Create Organization Phone
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Create Organization Social Media
Create Organization Social Media
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Update Organization
Update Organization
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Update Organization Email
Update Organization Email
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Update Organization Phone
Update Organization Phone
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Update Organization Address
Update Organization Address
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization
Get Organization
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization Email(s)
Get Organization Email(s)
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization Phone(s)
Get Organization Phone(s)
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization Address
Get Organization Address
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization History
Get Organization History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization History Latest
Get Organization History Latest
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization Relationship
Get Organization Relationship
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization User (Linked User)
Get Organization User (Linked User)
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Organization Account (Linked Account)
Get Organization Account (Linked Account)
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Delete Organization
Delete Organization
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Delete Organization Email
Delete Organization Email
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Delete Organization Phone
Delete Organization Phone
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Delete Organization Address
Delete Organization Address
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|